Skip to content

docs(react): use JSX children instead of children prop #2355

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
scs0209 wants to merge 1 commit into
base: alpha
Choose a base branch
from
Open

docs(react): use JSX children instead of children prop #2355

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 10 additions & 11 deletions docs/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,8 @@ export default function App() {
triggerDebounceMs: 500,
},
]}
children={(field) => {
>
{(field) => {
// Avoid hasty abstractions. Render props are great!
return (
<>
Expand All @@ -104,12 +105,11 @@ export default function App() {
</>
)
}}
/>
</form.Field>
</div>
<div>
<form.Field
name="lastName"
children={(field) => (
<form.Field name="lastName">
{(field) => (
<>
<label htmlFor={field.name}>Last Name:</label>
<input
Expand All @@ -122,11 +122,12 @@ export default function App() {
<FieldInfo field={field} />
</>
)}
/>
</form.Field>
</div>
<form.Subscribe
selector={(state) => [state.canSubmit, state.isSubmitting]}
children={([canSubmit, isSubmitting]) => (
>
{([canSubmit, isSubmitting]) => (
<>
<button type="submit" disabled={!canSubmit}>
{isSubmitting ? '...' : 'Submit'}
Expand All @@ -143,7 +144,7 @@ export default function App() {
</button>
</>
)}
/>
</form.Subscribe>
</form>
</div>
)
Expand Down Expand Up @@ -424,9 +425,7 @@ function App() {
)}
</form.Field>
</div>
<form.Subscribe
selector={(state) => [state.canSubmit, state.isSubmitting] as const}
>
<form.Subscribe selector={(state) => [state.canSubmit, state.isSubmitting] as const}>
{(state) => (
<>
<button type="submit" disabled={!state()[0] || state()[1]}>
Expand Down
17 changes: 9 additions & 8 deletions examples/react/compiler/src/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,8 @@ export default function App() {
triggerDebounceMs: 500,
},
]}
children={(field) => {
>
{(field) => {
// Avoid hasty abstractions. Render props are great!
return (
<>
Expand All @@ -80,12 +81,11 @@ export default function App() {
</>
)
}}
/>
</form.Field>
</div>
<div>
<form.Field
name="lastName"
children={(field) => (
<form.Field name="lastName">
{(field) => (
<>
<label htmlFor={field.name}>Last Name:</label>
<input
Expand All @@ -98,11 +98,12 @@ export default function App() {
<FieldInfo field={field} />
</>
)}
/>
</form.Field>
</div>
<form.Subscribe
selector={(state) => [state.canSubmit, state.isSubmitting]}
children={([canSubmit, isSubmitting]) => (
>
{([canSubmit, isSubmitting]) => (
<>
<button type="submit" disabled={!canSubmit}>
{isSubmitting ? '...' : 'Submit'}
Expand All @@ -119,7 +120,7 @@ export default function App() {
</button>
</>
)}
/>
</form.Subscribe>
</form>
</div>
)
Expand Down
35 changes: 15 additions & 20 deletions examples/react/large-form/src/features/people/address-fields.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,26 +9,21 @@ export function AddressFields({ form }: AddressFieldsProps) {
return (
<div>
<h2>Address</h2>
<form.Field
name="address.line1"
children={(field) => <field.TextField label="Address Line 1" />}
/>
<form.Field
name="address.line2"
children={(field) => <field.TextField label="Address Line 2" />}
/>
<form.Field
name="address.city"
children={(field) => <field.TextField label="City" />}
/>
<form.Field
name="address.state"
children={(field) => <field.TextField label="State" />}
/>
<form.Field
name="address.zip"
children={(field) => <field.TextField label="ZIP Code" />}
/>
<form.Field name="address.line1">
{(field) => <field.TextField label="Address Line 1" />}
</form.Field>
<form.Field name="address.line2">
{(field) => <field.TextField label="Address Line 2" />}
</form.Field>
<form.Field name="address.city">
{(field) => <field.TextField label="City" />}
</form.Field>
<form.Field name="address.state">
{(field) => <field.TextField label="State" />}
</form.Field>
<form.Field name="address.zip">
{(field) => <field.TextField label="ZIP Code" />}
</form.Field>
</div>
)
}
12 changes: 6 additions & 6 deletions examples/react/large-form/src/features/people/emergency-contact.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ function EmergencyContactFields({
return (
<>
<fields.Field
name="fullName"
children={(field) => <field.TextField label="Full Name" />}
/>
name="fullName">
{(field) => <field.TextField label="Full Name" />}
</fields.Field>
<fields.Field
name="phone"
children={(field) => <field.TextField label="Phone" />}
/>
name="phone">
{(field) => <field.TextField label="Phone" />}
</fields.Field>
</>
)
}
Expand Down
21 changes: 9 additions & 12 deletions examples/react/large-form/src/features/people/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,15 @@ export const PeoplePage = () => {
}}
>
<h1>Personal Information</h1>
<form.Field
name="fullName"
children={(field) => <field.TextField label="Full Name" />}
/>
<form.Field
name="email"
children={(field) => <field.TextField label="Email" />}
/>
<form.Field
name="phone"
children={(field) => <field.TextField label="Phone" />}
/>
<form.Field name="fullName">
{(field) => <field.TextField label="Full Name" />}
</form.Field>
<form.Field name="email">
{(field) => <field.TextField label="Email" />}
</form.Field>
<form.Field name="phone">
{(field) => <field.TextField label="Phone" />}
</form.Field>
<AddressFields form={form} />
<h2>Emergency Contact</h2>
<FieldGroupEmergencyContact
Expand Down
5 changes: 3 additions & 2 deletions examples/react/query-integration/src/app.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,8 @@ export function App() {
</form.Field>
<form.Subscribe
selector={(state) => [state.canSubmit, state.isSubmitting]}
children={([canSubmit, isSubmitting]) => (
>
{([canSubmit, isSubmitting]) => (
<>
<button type="submit" disabled={!canSubmit}>
{isSubmitting ? '...' : 'Submit'}
Expand All @@ -127,7 +128,7 @@ export function App() {
</button>
</>
)}
/>
</form.Subscribe>
</form>
</div>
)
Expand Down
17 changes: 9 additions & 8 deletions examples/react/simple/src/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,8 @@ export default function App() {
triggerDebounceMs: 500,
},
]}
children={(field) => {
>
{(field) => {
// Avoid hasty abstractions. Render props are great!
return (
<>
Expand All @@ -82,12 +83,11 @@ export default function App() {
</>
)
}}
/>
</form.Field>
</div>
<div>
<form.Field
name="lastName"
children={(field) => (
<form.Field name="lastName">
{(field) => (
<>
<label htmlFor={field.name}>Last Name:</label>
<input
Expand All @@ -100,11 +100,12 @@ export default function App() {
<FieldInfo field={field} />
</>
)}
/>
</form.Field>
</div>
<form.Subscribe
selector={(state) => [state.canSubmit, state.isSubmitting]}
children={([canSubmit, isSubmitting]) => (
>
{([canSubmit, isSubmitting]) => (
<>
<button type="submit" disabled={!canSubmit}>
{isSubmitting ? '...' : 'Submit'}
Expand All @@ -121,7 +122,7 @@ export default function App() {
</button>
</>
)}
/>
</form.Subscribe>
</form>
</div>
)
Expand Down
19 changes: 9 additions & 10 deletions examples/react/standard-schema/src/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,8 @@ export default function App() {
>
<div>
{/* A type-safe field component*/}
<form.Field
name="firstName"
children={(field) => {
<form.Field name="firstName">
{(field) => {
// Avoid hasty abstractions. Render props are great!
return (
<>
Expand All @@ -117,12 +116,11 @@ export default function App() {
</>
)
}}
/>
</form.Field>
</div>
<div>
<form.Field
name="lastName"
children={(field) => (
<form.Field name="lastName">
{(field) => (
<>
<label htmlFor={field.name}>Last Name:</label>
<input
Expand All @@ -135,16 +133,17 @@ export default function App() {
<FieldInfo field={field} />
</>
)}
/>
</form.Field>
</div>
<form.Subscribe
selector={(state) => [state.canSubmit, state.isSubmitting]}
children={([canSubmit, isSubmitting]) => (
>
{([canSubmit, isSubmitting]) => (
<button type="submit" disabled={!canSubmit}>
{isSubmitting ? '...' : 'Submit'}
</button>
)}
/>
</form.Subscribe>
</form>
</div>
)
Expand Down