Skip to content

Rename Component with Layout in the docs #1

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
Devessier wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Rename Component with Layout in the docs #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ad81f0e
docs: rename Component to Layout in the docs
Devessier Jan 11, 2025
1902ea4
fix: do not use the Layout property for "end" states as it won't work
Devessier Jan 11, 2025
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
48 changes: 21 additions & 27 deletions examples/src/App.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,35 +5,29 @@ import { createMachineComponent } from "@webinargeek/machine-component"

const Count = createMachineComponent<CountMachine>({
states: {
a: {
Component: ({ actorRef }) => {
const count = useSelector(actorRef, (state) => state.context.count)
a: ({ actorRef }) => {
const count = useSelector(actorRef, (state) => state.context.count)

return (
<>
<div className="card">
<button onClick={() => actorRef.send({ type: "count" })}>
count is {count}
</button>
</div>
<div className="card">
<button onClick={() => actorRef.send({ type: "stop" })}>
Stop
</button>
</div>
</>
)
},
},
b: {
Component: ({ actorRef }) => (
<div className="card">
<button onClick={() => actorRef.send({ type: "start" })}>
Start
</button>
</div>
),
return (
<>
<div className="card">
<button onClick={() => actorRef.send({ type: "count" })}>
count is {count}
</button>
</div>
<div className="card">
<button onClick={() => actorRef.send({ type: "stop" })}>
Stop
</button>
</div>
</>
)
},
b: ({ actorRef }) => (
<div className="card">
<button onClick={() => actorRef.send({ type: "start" })}>Start</button>
</div>
),
},
})

Expand Down
6 changes: 3 additions & 3 deletions packages/machine-component/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,15 +88,15 @@ const App = () => {

### Layout components

A Component can be passed to the `Component` field of a parent state which will be rendered without being unmounted as the child states change.
A component can be passed to the `Layout` field of a parent state which will be rendered without being unmounted as the child states change.

The components defined in the child states will be passed into the `children` prop.

```tsx
const Component = createMachineComponent<MyMachine>({
states: {
a: {
Component: () => <div>A {children}</div>,
Layout: ({ children }) => <div>A {children}</div>,
states: {
b: () => <div>B</div>,
c: () => <div>C</div>,
Expand All @@ -117,7 +117,7 @@ The state components will also receive the `actorRef` prop that was passed to th
const Component = createMachineComponent<MyMachine, { foo: string }>({
states: {
a: {
Component: ({ foo }) => <div>A {foo}</div>,
Layout: ({ foo }) => <div>A {foo}</div>,
},
b: ({ foo }) => <div>B {foo}</div>,
c: ({ children, actorRef }) => {
Expand Down