Skip to content
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

[docs-infra] New Component API design followup #38183

Merged
merged 17 commits into from
Aug 2, 2023
Merged

[docs-infra] New Component API design followup #38183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
1f36eb2
update component props typing
cherniavskii Jul 27, 2023
df4e574
fix typo
cherniavskii Jul 27, 2023
00d7432
docs:api
cherniavskii Jul 27, 2023
af800c9
fix additionalInfo styles
cherniavskii Jul 27, 2023
7bd5618
simplify array concatenation
cherniavskii Jul 27, 2023
cb6ddfd
avoid any type
cherniavskii Jul 27, 2023
ee7fef1
Merge branch 'master' into update-component-api-page
cherniavskii Jul 31, 2023
2e54aec
docs:api
cherniavskii Jul 31, 2023
dbe2e32
tweak classNames
alexfauquette Aug 1, 2023
910dbae
remove wrong note
alexfauquette Aug 1, 2023
ba6060c
split dedicated styling
alexfauquette Aug 1, 2023
8f0b6af
Merge remote-tracking branch 'upstream/master' into update-component-…
alexfauquette Aug 1, 2023
441e8de
add modifications from #38196
alexfauquette Aug 1, 2023
b93f35f
fix lint
alexfauquette Aug 1, 2023
33de9d7
prettier
alexfauquette Aug 1, 2023
e1b0df5
Merge remote-tracking branch 'upstream/master' into update-component-…
alexfauquette Aug 1, 2023
07ea0a1
move default slot outside of the header
alexfauquette Aug 1, 2023
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
2 changes: 1 addition & 1 deletion docs/pages/base-ui/api/badge.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"slots": {
"type": { "name": "shape", "description": "{ badge?: elementType, root?: elementType }" },
"default": "{}",
"additionalPropsInfo": { "slotsApi": true }
"additionalInfo": { "slotsApi": true }
}
},
"name": "Badge",
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/base-ui/api/button.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalPropsInfo": { "slotsApi": true }
"additionalInfo": { "slotsApi": true }
}
},
"name": "Button",
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/base-ui/api/form-control.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalPropsInfo": { "slotsApi": true }
"additionalInfo": { "slotsApi": true }
},
"value": { "type": { "name": "any" } }
},
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/base-ui/api/input.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"description": "{ input?: elementType, root?: elementType, textarea?: elementType }"
},
"default": "{}",
"additionalPropsInfo": { "slotsApi": true }
"additionalInfo": { "slotsApi": true }
},
"startAdornment": { "type": { "name": "node" } },
"type": {
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/base-ui/api/menu-button.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalPropsInfo": { "slotsApi": true }
"additionalInfo": { "slotsApi": true }
}
},
"name": "MenuButton",
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/base-ui/api/menu-item.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalPropsInfo": { "slotsApi": true }
"additionalInfo": { "slotsApi": true }
}
},
"name": "MenuItem",
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/base-ui/api/menu.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"slots": {
"type": { "name": "shape", "description": "{ listbox?: elementType, root?: elementType }" },
"default": "{}",
"additionalPropsInfo": { "slotsApi": true }
"additionalInfo": { "slotsApi": true }
}
},
"name": "Menu",
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/base-ui/api/modal.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
"slots": {
"type": { "name": "shape", "description": "{ backdrop?: elementType, root?: elementType }" },
"default": "{}",
"additionalPropsInfo": { "slotsApi": true }
"additionalInfo": { "slotsApi": true }
}
},
"name": "Modal",
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/base-ui/api/option-group.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"description": "{ label?: elementType, list?: elementType, root?: elementType }"
},
"default": "{}",
"additionalPropsInfo": { "slotsApi": true }
"additionalInfo": { "slotsApi": true }
}
},
"name": "OptionGroup",
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/base-ui/api/option.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalPropsInfo": { "slotsApi": true }
"additionalInfo": { "slotsApi": true }
}
},
"name": "Option",
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/base-ui/api/popper.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalPropsInfo": { "slotsApi": true }
"additionalInfo": { "slotsApi": true }
},
"transition": { "type": { "name": "bool" }, "default": "false" }
},
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/base-ui/api/select.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"description": "{ listbox?: elementType, popper?: elementType, root?: elementType }"
},
"default": "{}",
"additionalPropsInfo": { "slotsApi": true }
"additionalInfo": { "slotsApi": true }
},
"value": { "type": { "name": "any" } }
},
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/base-ui/api/slider.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
"description": "{ input?: elementType, mark?: elementType, markLabel?: elementType, rail?: elementType, root?: elementType, thumb?: elementType, track?: elementType, valueLabel?: elementType }"
},
"default": "{}",
"additionalPropsInfo": { "slotsApi": true }
"additionalInfo": { "slotsApi": true }
},
"step": { "type": { "name": "number" }, "default": "1" },
"tabIndex": { "type": { "name": "number" } },
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/base-ui/api/snackbar.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalPropsInfo": { "slotsApi": true }
"additionalInfo": { "slotsApi": true }
}
},
"name": "Snackbar",
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/base-ui/api/switch.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"description": "{ input?: elementType, root?: elementType, thumb?: elementType, track?: elementType<br>&#124;&nbsp;null }"
},
"default": "{}",
"additionalPropsInfo": { "slotsApi": true }
"additionalInfo": { "slotsApi": true }
}
},
"name": "Switch",
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/base-ui/api/tab-panel.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalPropsInfo": { "slotsApi": true }
"additionalInfo": { "slotsApi": true }
},
"value": { "type": { "name": "union", "description": "number<br>&#124;&nbsp;string" } }
},
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/base-ui/api/tab.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalPropsInfo": { "slotsApi": true }
"additionalInfo": { "slotsApi": true }
},
"value": { "type": { "name": "union", "description": "number<br>&#124;&nbsp;string" } }
},
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/base-ui/api/table-pagination.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
"description": "{ actions?: elementType, displayedRows?: elementType, menuItem?: elementType, root?: elementType, select?: elementType, selectLabel?: elementType, spacer?: elementType, toolbar?: elementType }"
},
"default": "{}",
"additionalPropsInfo": { "slotsApi": true }
"additionalInfo": { "slotsApi": true }
}
},
"name": "TablePagination",
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/base-ui/api/tabs-list.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalPropsInfo": { "slotsApi": true }
"additionalInfo": { "slotsApi": true }
}
},
"name": "TabsList",
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/base-ui/api/tabs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalPropsInfo": { "slotsApi": true }
"additionalInfo": { "slotsApi": true }
},
"value": { "type": { "name": "union", "description": "number<br>&#124;&nbsp;string" } }
},
Expand Down
10 changes: 5 additions & 5 deletions docs/pages/joy-ui/api/alert.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"default": "'neutral'",
"additionalPropsInfo": { "joy-color": true }
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"endDecorator": { "type": { "name": "node" } },
Expand All @@ -18,7 +18,7 @@
"description": "'sm'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'lg'<br>&#124;&nbsp;string"
},
"default": "'md'",
"additionalPropsInfo": { "joy-size": true }
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": {
Expand All @@ -33,23 +33,23 @@
"description": "{ endDecorator?: elementType, root?: elementType, startDecorator?: elementType }"
},
"default": "{}",
"additionalPropsInfo": { "slotsApi": true }
"additionalInfo": { "slotsApi": true }
},
"startDecorator": { "type": { "name": "node" } },
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalPropsInfo": { "sx": true }
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
},
"default": "'outlined'",
"additionalPropsInfo": { "joy-variant": true }
"additionalInfo": { "joy-variant": true }
}
},
"name": "Alert",
Expand Down
8 changes: 4 additions & 4 deletions docs/pages/joy-ui/api/aspect-ratio.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'"
},
"default": "'neutral'",
"additionalPropsInfo": { "joy-color": true }
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"maxHeight": { "type": { "name": "union", "description": "number<br>&#124;&nbsp;string" } },
Expand All @@ -33,22 +33,22 @@
"slots": {
"type": { "name": "shape", "description": "{ content?: elementType, root?: elementType }" },
"default": "{}",
"additionalPropsInfo": { "slotsApi": true }
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalPropsInfo": { "sx": true }
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
},
"default": "'soft'",
"additionalPropsInfo": { "joy-variant": true }
"additionalInfo": { "joy-variant": true }
}
},
"name": "AspectRatio",
Expand Down
10 changes: 5 additions & 5 deletions docs/pages/joy-ui/api/autocomplete-listbox.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"default": "'neutral'",
"additionalPropsInfo": { "joy-color": true }
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"size": {
"type": { "name": "enum", "description": "'sm'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'lg'" },
"default": "'md'",
"additionalPropsInfo": { "joy-size": true }
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
Expand All @@ -21,22 +21,22 @@
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalPropsInfo": { "slotsApi": true }
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalPropsInfo": { "sx": true }
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'contained'<br>&#124;&nbsp;'light'<br>&#124;&nbsp;'outlined'<br>&#124;&nbsp;'text'<br>&#124;&nbsp;string"
},
"default": "'outlined'",
"additionalPropsInfo": { "joy-variant": true }
"additionalInfo": { "joy-variant": true }
}
},
"name": "AutocompleteListbox",
Expand Down
8 changes: 4 additions & 4 deletions docs/pages/joy-ui/api/autocomplete-option.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"default": "'neutral'",
"additionalPropsInfo": { "joy-color": true }
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"slotProps": {
Expand All @@ -16,22 +16,22 @@
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalPropsInfo": { "slotsApi": true }
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalPropsInfo": { "sx": true }
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'contained'<br>&#124;&nbsp;'light'<br>&#124;&nbsp;'outlined'<br>&#124;&nbsp;'text'<br>&#124;&nbsp;string"
},
"default": "'plain'",
"additionalPropsInfo": { "joy-variant": true }
"additionalInfo": { "joy-variant": true }
}
},
"name": "AutocompleteOption",
Expand Down
10 changes: 5 additions & 5 deletions docs/pages/joy-ui/api/autocomplete.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'"
},
"default": "'neutral'",
"additionalPropsInfo": { "joy-color": true }
"additionalInfo": { "joy-color": true }
},
"defaultValue": {
"type": { "name": "custom", "description": "any" },
Expand Down Expand Up @@ -141,7 +141,7 @@
"description": "'sm'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'lg'<br>&#124;&nbsp;string"
},
"default": "'md'",
"additionalPropsInfo": { "joy-size": true }
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": {
Expand All @@ -156,15 +156,15 @@
"description": "{ clearIndicator?: elementType, endDecorator?: elementType, input?: elementType, limitTag?: elementType, listbox?: elementType, loading?: elementType, noOptions?: elementType, option?: elementType, popupIndicator?: elementType, root?: elementType, startDecorator?: elementType, wrapper?: elementType }"
},
"default": "{}",
"additionalPropsInfo": { "slotsApi": true }
"additionalInfo": { "slotsApi": true }
},
"startDecorator": { "type": { "name": "node" } },
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalPropsInfo": { "sx": true }
"additionalInfo": { "sx": true }
},
"type": { "type": { "name": "string" } },
"value": { "type": { "name": "custom", "description": "any" } },
Expand All @@ -174,7 +174,7 @@
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'"
},
"default": "'outlined'",
"additionalPropsInfo": { "joy-variant": true }
"additionalInfo": { "joy-variant": true }
}
},
"name": "Autocomplete",
Expand Down
Loading