Skip to content

Commit 034799b

Browse files
PagebakersPagebakers
committed
chore: check in props docs
1 parent 9494b15 commit 034799b

File tree

213 files changed

+20257
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

213 files changed

+20257
-0
lines changed

‎.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ __snapshots__
2424
**/dist
2525
**/build/**
2626

27+
# we include these files so they don't have to be re-build when deploying to Vercel
28+
!tooling/props-docs/dist
29+
2730
# misc
2831
.DS_Store
2932
*.pem

‎tooling/props-docs/dist/components/AppShell.json

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"AppShell": {
3+
"aside": {
4+
"type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement<any, string | JSXElementConstructor<any>>\n | Iterable<ReactNode>\n | ReactPortal\n | PromiseLikeOfReactNode",
5+
"required": false,
6+
"description": "Secondary sidebar, positioned on the right"
7+
},
8+
"children": {
9+
"type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement<any, string | JSXElementConstructor<any>>\n | Iterable<ReactNode>\n | ReactPortal\n | PromiseLikeOfReactNode",
10+
"required": false,
11+
"description": "The main content"
12+
},
13+
"footer": {
14+
"type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement<any, string | JSXElementConstructor<any>>\n | Iterable<ReactNode>\n | ReactPortal\n | PromiseLikeOfReactNode",
15+
"required": false,
16+
"description": "The footer"
17+
},
18+
"mainRef": { "type": "RefObject<HTMLDivElement>", "required": false },
19+
"navbar": {
20+
"type": "type ONLY_FOR_FORMAT =\n | string\n | number\n | boolean\n | ReactElement<any, string | JSXElementConstructor<any>>\n | Iterable<ReactNode>\n | ReactPortal\n | PromiseLikeOfReactNode",
21+
"required": false,
22+
"description": "The top header navigation"
23+
},
24+
"sidebar": {
25+
"type": "ReactElement<any, string | JSXElementConstructor<any>>",
26+
"required": false,
27+
"description": "Main sidebar, positioned on the left"
28+
}
29+
}
30+
}

‎tooling/props-docs/dist/components/ArrayField.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"tags":{"see":"Docs https://saas-ui.dev/docs/components/forms/array-field"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"The wrapper component that composes the default ArrayField functionality.","displayName":"ArrayField","methods":[],"props":{"name":{"defaultValue":null,"description":"The field name","name":"name","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"}],"required":true,"type":{"name":"string"}},"defaultValue":{"defaultValue":null,"description":"Default value for new values in the array","name":"defaultValue","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"}],"required":false,"type":{"name":"Record<string, any>"}},"keyName":{"defaultValue":{"value":"\"id\""},"description":"Default key name for rows, change this if your data uses a different 'id' field","name":"keyName","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"}],"required":false,"type":{"name":"string"}},"min":{"defaultValue":null,"description":"","name":"min","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"}],"required":false,"type":{"name":"number"}},"max":{"defaultValue":null,"description":"","name":"max","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"}],"required":false,"type":{"name":"number"}},"label":{"defaultValue":null,"description":"The field label","name":"label","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"placeholder":{"defaultValue":null,"description":"The input placeholder","name":"placeholder","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"help":{"defaultValue":null,"description":"Field help text","name":"help","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"type":{"defaultValue":null,"description":"Build-in types:\ntext, number, password, textarea, select, native-select, checkbox, radio, switch, pin\n\nWill default to a text field if there is no matching type.","name":"type","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"hideLabel":{"defaultValue":null,"description":"Hide the field label","name":"hideLabel","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"boolean"}},"rules":{"defaultValue":null,"description":"React hook form rules","name":"rules","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"Omit<RegisterOptions<FieldValues, string>, \"disabled\" | \"valueAsNumber\" | \"valueAsDate\" | \"setValueAs\">"}},"ref":{"defaultValue":null,"description":"","name":"ref","declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"TypeLiteral"}],"required":false,"type":{"name":"ForwardedRef<UseArrayFieldReturn>"}}}}

‎tooling/props-docs/dist/components/ArrayFieldContainer.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"tags":{"see":"Docs https://saas-ui.dev/docs/components/forms/array-field"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"The container component provides context and state management.","displayName":"ArrayFieldContainer","methods":[],"props":{"label":{"defaultValue":null,"description":"The field label","name":"label","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"defaultValue":{"defaultValue":null,"description":"Default value for new values in the array","name":"defaultValue","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"}],"required":false,"type":{"name":"Record<string, any>"}},"placeholder":{"defaultValue":null,"description":"The input placeholder","name":"placeholder","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"help":{"defaultValue":null,"description":"Field help text","name":"help","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"type":{"defaultValue":null,"description":"Build-in types:\ntext, number, password, textarea, select, native-select, checkbox, radio, switch, pin\n\nWill default to a text field if there is no matching type.","name":"type","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"string"}},"min":{"defaultValue":null,"description":"","name":"min","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"}],"required":false,"type":{"name":"number"}},"max":{"defaultValue":null,"description":"","name":"max","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"}],"required":false,"type":{"name":"number"}},"name":{"defaultValue":null,"description":"The field name","name":"name","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"}],"required":true,"type":{"name":"string"}},"hideLabel":{"defaultValue":null,"description":"Hide the field label","name":"hideLabel","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"boolean"}},"rules":{"defaultValue":null,"description":"React hook form rules","name":"rules","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"BaseFieldProps"}],"required":false,"type":{"name":"Omit<RegisterOptions<FieldValues, string>, \"disabled\" | \"valueAsNumber\" | \"valueAsDate\" | \"setValueAs\">"}},"keyName":{"defaultValue":{"value":"\"id\""},"description":"Default key name for rows, change this if your data uses a different 'id' field","name":"keyName","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldOptions"}],"required":false,"type":{"name":"string"}}}}

‎tooling/props-docs/dist/components/ArrayFieldRow.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"tags":{"see":"Docs https://saas-ui.dev/docs/components/forms/array-field"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"Render prop component, to get access to the internal fields state. Must be a child of ArrayFieldContainer.","displayName":"ArrayFieldRow","methods":[],"props":{"columns":{"defaultValue":null,"description":"Amount of field columns","name":"columns","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"}],"required":false,"type":{"name":"ResponsiveValue<number>"}},"spacing":{"defaultValue":null,"description":"Spacing between fields","name":"spacing","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"}],"required":false,"type":{"name":"ResponsiveValue<string | number>"}},"index":{"defaultValue":null,"description":"The array index","name":"index","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"}],"required":true,"type":{"name":"number"}},"children":{"defaultValue":null,"description":"The fields","name":"children","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"}],"required":true,"type":{"name":"ReactNode"}}}}

‎tooling/props-docs/dist/components/ArrayFieldRowContainer.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"tags":{"see":"Docs https://saas-ui.dev/docs/components/forms/array-field"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"The row container component providers row context.","displayName":"ArrayFieldRowContainer","methods":[],"props":{"columns":{"defaultValue":null,"description":"Amount of field columns","name":"columns","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"}],"required":false,"type":{"name":"ResponsiveValue<number>"}},"spacing":{"defaultValue":null,"description":"Spacing between fields","name":"spacing","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"}],"required":false,"type":{"name":"ResponsiveValue<string | number>"}},"index":{"defaultValue":null,"description":"The array index","name":"index","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"}],"required":true,"type":{"name":"number"}},"children":{"defaultValue":null,"description":"The fields","name":"children","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowProps"}],"required":true,"type":{"name":"ReactNode"}}}}

‎tooling/props-docs/dist/components/ArrayFieldRowFields.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"tags":{"see":"Docs https://saas-ui.dev/docs/components/forms/array-field"},"filePath":"/Users/eelco/Development/appulse/saas-ui/packages/saas-ui-react/src/index.ts","description":"Add the name prefix to the fields and acts as a horizontal form layout by default.","displayName":"ArrayFieldRowFields","methods":[],"props":{"columns":{"defaultValue":null,"description":"Amount of field columns","name":"columns","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowFieldsProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowFieldsProps"}],"required":false,"type":{"name":"ResponsiveValue<number>"}},"spacing":{"defaultValue":null,"description":"Spacing between fields","name":"spacing","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowFieldsProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowFieldsProps"}],"required":false,"type":{"name":"ResponsiveValue<string | number>"}},"children":{"defaultValue":null,"description":"The fields","name":"children","parent":{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowFieldsProps"},"declarations":[{"fileName":"saas-ui/packages/saas-ui-forms/dist/index.d.ts","name":"ArrayFieldRowFieldsProps"}],"required":true,"type":{"name":"ReactNode"}}}}

0 commit comments

Comments
 (0)