Skip to content

Docs: improve README and ADVANCED.md #177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
roni-castro wants to merge 4 commits into
base: development
Choose a base branch
from
+13 −10
Open

Docs: improve README and ADVANCED.md #177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ec6eb66
Enhance ADVANCED.md by adding a working example
roni-castro Oct 14, 2024
45077b0
Update README CounterStore code to use export default
roni-castro Oct 14, 2024
58503a4
Remove unecesssary custom function and interval props
roni-castro Oct 14, 2024
904c601
Refactor the app snippet to export the provider in the new format
roni-castro Oct 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions osmosis/ADVANCED.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ import { setupStore } from '@shipt/osmosis';

const useCounterStore = props => {
const [count, setCount] = useState(0);
const interval = props.interval ?? 0;
const interval = props.interval ?? 1;

const increment = () => {
setCount(count + interval);
Expand Down Expand Up @@ -57,9 +57,9 @@ export default CounterStore;
```jsx
//counter.js
import React from 'react';
import { CounterStore } from './counter.store';
import CounterStore from './counter.store';

export default () => {
const Counter = () => {
const {
state: { count, interval },
increment,
Expand All @@ -74,25 +74,28 @@ export default () => {
</div>
);
};

export default CounterStore.Provider(Counter);
```

```jsx
//index.js Root Component
import React from 'react'
import { CounterStore } from './counter.store';
import React from 'react';
import { StoreProvider } from '@shipt/osmosis';
import CounterStore from './counter.store';
import Counter from './counter';

const intervals = [1, 2, 3];

const Counters = () => {
const App = () => {
return (
<>
{intervals.map(interval => (
<Counter key={String(interval)} storeKey={interval} interval={interval} />
))}
</>
);
});
};

export default CounterStore.Provider(Counters);
export default StoreProvider([CounterStore], App);
```
4 changes: 2 additions & 2 deletions osmosis/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ export default CounterStore;
```jsx
//counter.js
import React from 'react';
import { CounterStore } from './counter.store';
import CounterStore from './counter.store';

export default () => {
const {
Expand All @@ -105,7 +105,7 @@ export default () => {
```jsx
//index.js Root Component
import { StoreProvider } from '@shipt/osmosis';
import { CounterStore } from './counter.store';
import CounterStore from './counter.store';
import Counter from './counter';

export default StoreProvider([CounterStore.Provider], Counter);
Expand Down