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

Jump to bottom

[docs] Fix double API page redirection #36743

Merged
merged 4 commits into from
Apr 4, 2023
Merged

[docs] Fix double API page redirection #36743

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9be0bb8
[docs] Fix double API page redirection
oliviertassinari Apr 1, 2023
345da84
Merge branch 'master' into fix-double-redirect-base-api
mnajdova Apr 4, 2023
91ff076
run docs:api
siriwatknp Apr 4, 2023
d179c95
fix hash
siriwatknp Apr 4, 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: 2 additions & 0 deletions docs/pages/joy-ui/api/modal-overflow.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
"name": "ModalOverflow",
"styles": { "classes": [], "globalClasses": {}, "name": null },
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyModalOverflow",
Comment on lines +13 to +14
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#36262 did not update with the latest master.

"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/ModalOverflow/ModalOverflow.tsx",
"inheritance": null,
Expand Down
85 changes: 45 additions & 40 deletions docs/public/_redirects
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -414,46 +414,51 @@ https://v4.material-ui.com/* https://v4.mui.com/:splat 301!
/material-ui/guides/flow/ https://v4.mui.com/guides/flow/ 301
/:lang/material-ui/guides/flow/ https://v4.mui.com/:lang/guides/flow/ 301
# 2023
/base/api/badge-unstyled /base/react-badge/components-api#badge-unstyled 301
/base/api/button-unstyled /base/react-button/components-api#button-unstyled 301
/base/api/click-away-listener /base/react-click-away-listener/components-api#click-away-listener 301
/base/api/focus-trap /base/react-focus-trap/components-api#focus-trap 301
/base/api/form-control-unstyled /base/react-form-control/components-api#form-control-unstyled 301
/base/api/input-unstyled /base/react-input/components-api#input-unstyled 301
/base/api/menu-item-unstyled /base/react-menu/components-api#menu-item-unstyled 301
/base/api/menu-unstyled /base/react-menu/components-api#menu-unstyled 301
/base/api/modal-unstyled /base/react-modal/components-api#modal-unstyled 301
/base/api/no-ssr /base/react-no-ssr/components-api#no-ssr 301
/base/api/option-group-unstyled /base/react-select/components-api#option-group-unstyled 301
/base/api/option-unstyled /base/react-select/components-api#option-unstyled 301
/base/api/popper-unstyled /base/react-popper/components-api#popper-unstyled 301
/base/api/portal /base/react-portal/components-api#portal 301
/base/api/select-unstyled /base/react-select/components-api#select-unstyled 301
/base/api/slider-unstyled /base/react-slider/components-api#slider-unstyled 301
/base/api/snackbar-unstyled /base/react-snackbar/components-api#snackbar-unstyled 301
/base/api/switch-unstyled /base/react-switch/components-api#switch-unstyled 301
/base/api/table-pagination-unstyled /base/react-table-pagination/components-api#table-pagination-unstyled 301
/base/api/tab-panel-unstyled /base/react-tabs/components-api#tab-panel-unstyled 301
/base/api/tabs-list-unstyled /base/react-tabs/components-api#tabs-list-unstyled 301
/base/api/tabs-unstyled /base/react-tabs/components-api#tabs-unstyled 301
/base/api/tab-unstyled /base/react-tabs/components-api#tab-unstyled 301
/base/api/textarea-autosize /base/react-textarea-autosize/components-api#textarea-autosize 301
# /base/api/use-autocomplete /base/react-autocomplete/hooks-api#use-autocomplete 301
/base/api/use-badge /base/react-badge/hooks-api#use-badge 301
/base/api/use-button /base/react-button/hooks-api#use-button 301
/base/api/use-form-control-unstyled-context /base/react-form-control/hooks-api#use-form-control-unstyled-context 301
/base/api/use-input /base/react-input/hooks-api#use-input 301
/base/api/use-menu /base/react-menu/hooks-api#use-menu 301
/base/api/use-menu-item /base/react-menu/hooks-api#use-menu-item 301
/base/api/use-option /base/react-select/hooks-api#use-option 301
/base/api/use-select /base/react-select/hooks-api#use-select 301
/base/api/use-slider /base/react-slider/hooks-api#use-slider 301
/base/api/use-snackbar /base/react-snackbar/hooks-api#use-snackbar 301
/base/api/use-switch /base/react-switch/hooks-api#use-switch 301
/base/api/use-tab /base/react-tabs/hooks-api#use-tab 301
/base/api/use-tab-panel /base/react-tabs/hooks-api#use-tab-panel 301
/base/api/use-tabs /base/react-tabs/hooks-api#use-tabs 301
/base/api/use-tabs-list /base/react-tabs/hooks-api#use-tabs-list 301

# APIs

## Base UI

/base/api/badge-unstyled/ /base/react-badge/components-api/#badge-unstyled 301
/base/api/button-unstyled/ /base/react-button/components-api/#button-unstyled 301
/base/api/click-away-listener/ /base/react-click-away-listener/components-api/#click-away-listener 301
/base/api/focus-trap/ /base/react-focus-trap/components-api/#focus-trap 301
/base/api/form-control-unstyled/ /base/react-form-control/components-api/#form-control-unstyled 301
/base/api/input-unstyled/ /base/react-input/components-api/#input-unstyled 301
/base/api/menu-item-unstyled/ /base/react-menu/components-api/#menu-item-unstyled 301
/base/api/menu-unstyled/ /base/react-menu/components-api/#menu-unstyled 301
/base/api/modal-unstyled/ /base/react-modal/components-api/#modal-unstyled 301
/base/api/no-ssr/ /base/react-no-ssr/components-api/#no-ssr 301
/base/api/option-group-unstyled/ /base/react-select/components-api/#option-group-unstyled 301
/base/api/option-unstyled/ /base/react-select/components-api/#option-unstyled 301
/base/api/popper-unstyled/ /base/react-popper/components-api/#popper-unstyled 301
/base/api/portal/ /base/react-portal/components-api/#portal 301
/base/api/select-unstyled/ /base/react-select/components-api/#select-unstyled 301
/base/api/slider-unstyled/ /base/react-slider/components-api/#slider-unstyled 301
/base/api/snackbar-unstyled/ /base/react-snackbar/components-api/#snackbar-unstyled 301
/base/api/switch-unstyled/ /base/react-switch/components-api/#switch-unstyled 301
/base/api/table-pagination-unstyled/ /base/react-table-pagination/components-api/#table-pagination-unstyled 301
/base/api/tab-panel-unstyled/ /base/react-tabs/components-api/#tab-panel-unstyled 301
/base/api/tabs-list-unstyled/ /base/react-tabs/components-api/#tabs-list-unstyled 301
/base/api/tabs-unstyled/ /base/react-tabs/components-api/#tabs-unstyled 301
/base/api/tab-unstyled/ /base/react-tabs/components-api/#tab-unstyled 301
/base/api/textarea-autosize/ /base/react-textarea-autosize/components-api/#textarea-autosize 301
/base/api/use-badge/ /base/react-badge/hooks-api/#use-badge 301
/base/api/use-button/ /base/react-button/hooks-api/#use-button 301
/base/api/use-form-control-unstyled-context/ /base/react-form-control/hooks-api/#use-form-control-unstyled-context 301
/base/api/use-input/ /base/react-input/hooks-api/#use-input 301
/base/api/use-menu/ /base/react-menu/hooks-api/#use-menu 301
/base/api/use-menu-item/ /base/react-menu/hooks-api/#use-menu-item 301
/base/api/use-option/ /base/react-select/hooks-api/#use-option 301
/base/api/use-select/ /base/react-select/hooks-api/#use-select 301
/base/api/use-slider/ /base/react-slider/hooks-api/#use-slider 301
/base/api/use-snackbar/ /base/react-snackbar/hooks-api/#use-snackbar 301
Copy link
Member Author

@oliviertassinari oliviertassinari Apr 1, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A side note: the previous URLs feel clearer, when sharing them with someone else.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree, but the new urls are at least understandable and the overall DX feels better.

Copy link
Member Author

@oliviertassinari oliviertassinari Apr 8, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mnajdova I wonder if /props/ and /hooks/ could work better for the URL, e.g. https://ark-ui.com/docs/react/components/popover/props. It's shorter and maybe clearer. Nevermind, we probably want to keep API in the pathname, and props would be too narrow.

/base/api/use-switch/ /base/react-switch/hooks-api/#use-switch 301
/base/api/use-tab/ /base/react-tabs/hooks-api/#use-tab 301
/base/api/use-tab-panel/ /base/react-tabs/hooks-api/#use-tab-panel 301
/base/api/use-tabs/ /base/react-tabs/hooks-api/#use-tabs 301
/base/api/use-tabs-list/ /base/react-tabs/hooks-api/#use-tabs-list 301

/joy-ui/customization/theme-tokens/ /joy-ui/customization/theme-colors/ 301
/joy-ui/guides/apply-dark-mode/ /joy-ui/customization/dark-mode/ 301

Expand Down