From d62a6f3438f687cd996a78034137cb2471a8c9b5 Mon Sep 17 00:00:00 2001 From: Erin Donehoo Date: Mon, 26 Jun 2023 16:41:49 -0400 Subject: [PATCH 1/7] Update broken links. --- .../src/components/Alert/examples/Alert.md | 8 ++--- packages/react-core/src/helpers/OUIA/OUIA.md | 30 +++++++------------ 2 files changed, 15 insertions(+), 23 deletions(-) diff --git a/packages/react-core/src/components/Alert/examples/Alert.md b/packages/react-core/src/components/Alert/examples/Alert.md index 21c49c34607..66db8ac8ca6 100644 --- a/packages/react-core/src/components/Alert/examples/Alert.md +++ b/packages/react-core/src/components/Alert/examples/Alert.md @@ -137,7 +137,7 @@ const AlertTimeout: React.FunctionComponent = () => { An alert can contain additional, hidden information that is made visible when users click a caret icon. This information can be expanded and collapsed each time the icon is clicked. -It is not recommended to use an expandable alert with a `timeout` in a toast [alert group](/components/alert-group) because the alert could timeout before users have time to interact with and view the entire alert. +It is not recommended to use an expandable alert with a `timeout` in a [toast alert group](/components/alert#toast-alert-group) because the alert could timeout before users have time to interact with and view the entire alert. See the [toast alert considerations](/components/alert/accessibility#toast-alerts) section of the alert accessibility documentation to understand the accessibility risks associated with using toast alerts. @@ -354,7 +354,7 @@ import { Alert, AlertActionCloseButton } from '@patternfly/react-core'; ### Dynamic live region alerts -Alerts that are asynchronously appended into dynamic [alert groups](/components/alert-group) via the `isLiveRegion` property will be announced to assistive technology the moment the change happens, following the strategy used for `aria-atomic`, which defaults to false. This means only changes of type "addition" will be announced. +Alerts that are asynchronously appended into dynamic [alert groups](/components/alert/#alert-group-examples) via the `isLiveRegion` property will be announced to assistive technology the moment the change happens, following the strategy used for `aria-atomic`, which defaults to false. This means only changes of type "addition" will be announced. ```ts file="AlertDynamicLiveRegion.tsx" ``` @@ -379,7 +379,7 @@ Alert groups can be one of the following variants: | Toast | Toast alert groups contain alerts that typically appear in response to an asynchronous event or user action. These groups are positioned on top of other content at the top right of the page.| | Dynamic | Dynamic alert groups contain alerts that typically appear in response to a user action, and are seen within the normal page content flow.| -Dynamic alerts that are generated after the page initially loads must be appended to either a toast or dynamic `AlertGroup`, both of which must use the `isLiveRegion` property. New alerts appended to a toast or dynamic group will be announced by assistive technologies the moment the change happens. For information about customizing this announcement, read the [aria-atomic and aria-relevant](/components/alert-group/accessibility#aria-atomic-and-aria-relevant) section of the alert group accessibility documentation. +Dynamic alerts that are generated after the page initially loads must be appended to either a toast or dynamic `AlertGroup`, both of which must use the `isLiveRegion` property. New alerts appended to a toast or dynamic group will be announced by assistive technologies the moment the change happens. For information about customizing this announcement, read the [aria-atomic and aria-relevant](/components/alert/accessibility#aria-atomic-and-aria-relevant) section of the alert accessibility documentation. ### Static inline alert group @@ -414,7 +414,7 @@ Users navigating via keyboard or another assistive technology will need a way to The following example shows how alerts can be triggered by an asynchronous event in the application. You can customize how an alert will be announced to assistive technology by adjusting the value of the `aria-live` property. Click the "start async" alert button below and then click the buttons in the above toast examples to demonstrate how asynchronous events add alerts to a group. Click the "stop async alerts" button to halt this behavior. -See the [alert group accessibility tab](/components/alert-group/accessibility) for more information on customizing this behavior. +See the [alert accessibility tab](/components/alert/accessibility) for more information on customizing this behavior. ```ts file="./AlertGroupAsync.tsx" ``` diff --git a/packages/react-core/src/helpers/OUIA/OUIA.md b/packages/react-core/src/helpers/OUIA/OUIA.md index b92cf5944eb..237a1b3556e 100644 --- a/packages/react-core/src/helpers/OUIA/OUIA.md +++ b/packages/react-core/src/helpers/OUIA/OUIA.md @@ -59,38 +59,30 @@ import { Button } from '@patternfly/react-core'; * [Breadcrumb](/components/breadcrumb) * [Button](/components/button) * [Card](/components/card) -* [Checkbox](/components/checkbox) +* [Checkbox](/components/forms/checkbox) * [Chip](/components/chip) -* [ChipGroup](/components/chipg-roup) -* [ContextSelector](/components/context-selector) -* [Dropdown](/components/dropdown) -* [DropdownItem](/components/dropdown) -* [DropdownSeparator](/components/dropdown) -* [DropdownToggle](/components/dropdown) -* [DropdownToggleCheckbox](/components/dropdown) -* [FormSelect](/components/form-select) -* [Menu](/components/menu) +* [ContextSelector](/components/menus/context-selector) +* [Dropdown](/components/menus/dropdown) +* [DropdownItem](/components/menus/dropdown) +* [FormSelect](/components/forms/form-select) +* [Menu](/components/menu/menu) * [Modal](/components/modal) -* [ModalBoxCloseButton](/components/modal) -* [ModalContent](/components/modal) -* [Nav](/components/navigation) +* [Navigation](/components/navigation) * [NavExpandable](/components/navigation) * [NavItem](/components/navigation) -* [OptionsMenu](/components/options-menu) +* [OptionsMenu](/components/menu/options-menu) * [Pagination](/components/pagination) -* [Radio](/components/radio) -* [Select](/components/select) +* [Radio](/components/forms/radio) +* [Select](/components/menu/select) * [Switch](/components/switch) * [TabContent](/components/tabs) * [Tabs](/components/tabs) * [Text](/components/text) -* [TextInput](/components/text-input) +* [TextInput](/components/forms/text-input) * [Title](/components/title) * [Toolbar](/components/toolbar) ### react-table package -* [RowWrapper](/components/table) * [Table](/components/table) -* [TableComposable](/components/table) * [Tr](/components/table) From 51bfb496a9e0a1d11f5c319ffec0fbc4e8b2b9c8 Mon Sep 17 00:00:00 2001 From: Erin Donehoo Date: Tue, 27 Jun 2023 10:36:18 -0400 Subject: [PATCH 2/7] Fixes more broken links. --- .../react-core/src/components/Dropdown/examples/Dropdown.md | 2 +- packages/react-core/src/demos/DateTimePicker.md | 2 +- .../ApplicationLauncher/examples/ApplicationLauncher.md | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/react-core/src/components/Dropdown/examples/Dropdown.md b/packages/react-core/src/components/Dropdown/examples/Dropdown.md index a30813987aa..e826d27ee64 100644 --- a/packages/react-core/src/components/Dropdown/examples/Dropdown.md +++ b/packages/react-core/src/components/Dropdown/examples/Dropdown.md @@ -25,7 +25,7 @@ import EllipsisVIcon from '@patternfly/react-icons/dist/esm/icons/ellipsis-v-ico Basic dropdowns present users with a menu of items upon clicking a dropdown toggle. -A `` uses a [menu toggle](/components/menu-toggle), which is passed to the `toggle` property, as well as a `` with multiple `` components. To allow a dropdown to change the open state of the menu, pass the `isOpen` property into the `onOpenChange` callback. +A `` uses a [menu toggle](/components/menus/menu-toggle), which is passed to the `toggle` property, as well as a `` with multiple `` components. To allow a dropdown to change the open state of the menu, pass the `isOpen` property into the `onOpenChange` callback. The following example shows a few different states of dropdown items. As shown in this example, dropdown items may: diff --git a/packages/react-core/src/demos/DateTimePicker.md b/packages/react-core/src/demos/DateTimePicker.md index f37ac682575..028ff10193f 100644 --- a/packages/react-core/src/demos/DateTimePicker.md +++ b/packages/react-core/src/demos/DateTimePicker.md @@ -10,7 +10,7 @@ import OutlinedClockIcon from '@patternfly/react-icons/dist/esm/icons/outlined-c ## Demos -In this demo, learn how to use a [CalendarMonth](/components/calendar-month) component and a [Dropdown](/components/dropdown) component to compose a simple DateTimePicker. The input is read only, meaning that the following example does not cover pasting a copied date and time. Also, you can pick the time only from the predefined options and cannot change it in the input. +In this demo, learn how to use a [CalendarMonth](/components/date-and-time/calendar-month) component and a [Dropdown](/components/menus/dropdown) component to compose a simple DateTimePicker. The input is read only, meaning that the following example does not cover pasting a copied date and time. Also, you can pick the time only from the predefined options and cannot change it in the input. ### Date and time picker diff --git a/packages/react-core/src/deprecated/components/ApplicationLauncher/examples/ApplicationLauncher.md b/packages/react-core/src/deprecated/components/ApplicationLauncher/examples/ApplicationLauncher.md index f21d8ef2b02..182e716b00b 100644 --- a/packages/react-core/src/deprecated/components/ApplicationLauncher/examples/ApplicationLauncher.md +++ b/packages/react-core/src/deprecated/components/ApplicationLauncher/examples/ApplicationLauncher.md @@ -13,8 +13,8 @@ import HelpIcon from '@patternfly/react-icons/dist/esm/icons/help-icon'; import { Link } from '@reach/router'; import pfLogoSm from './pf-logo-small.svg'; -Note: Application launcher is built on Dropdown, for extended API go to [Dropdown](/documentation/react/components/dropdown) documentation. -To add a tooltip, use the `tooltip` prop and optionally add more tooltip props by using `tooltipProps`. For more tooltip information go to [Tooltip](/documentation/react/components/tooltip). +Note: Application launcher is built on Dropdown, for extended API go to [Dropdown](/components/menus/dropdown) documentation. +To add a tooltip, use the `tooltip` prop and optionally add more tooltip props by using `tooltipProps`. For more tooltip information go to [Tooltip](/components/tooltip). ## Examples From 7c16669d35bd446f9063cbfb0007d1be72864cb3 Mon Sep 17 00:00:00 2001 From: Erin Donehoo Date: Tue, 27 Jun 2023 11:17:35 -0400 Subject: [PATCH 3/7] A few edits. --- .../ApplicationLauncher/examples/ApplicationLauncher.md | 4 ++-- packages/react-core/src/helpers/OUIA/OUIA.md | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/packages/react-core/src/deprecated/components/ApplicationLauncher/examples/ApplicationLauncher.md b/packages/react-core/src/deprecated/components/ApplicationLauncher/examples/ApplicationLauncher.md index 182e716b00b..7fe793adac2 100644 --- a/packages/react-core/src/deprecated/components/ApplicationLauncher/examples/ApplicationLauncher.md +++ b/packages/react-core/src/deprecated/components/ApplicationLauncher/examples/ApplicationLauncher.md @@ -13,8 +13,8 @@ import HelpIcon from '@patternfly/react-icons/dist/esm/icons/help-icon'; import { Link } from '@reach/router'; import pfLogoSm from './pf-logo-small.svg'; -Note: Application launcher is built on Dropdown, for extended API go to [Dropdown](/components/menus/dropdown) documentation. -To add a tooltip, use the `tooltip` prop and optionally add more tooltip props by using `tooltipProps`. For more tooltip information go to [Tooltip](/components/tooltip). +Note: Application launcher is built on Dropdown, for extended API go to [Dropdown](/documentation/react/components/menus/dropdown) documentation. +To add a tooltip, use the `tooltip` prop and optionally add more tooltip props by using `tooltipProps`. For more tooltip information go to [Tooltip](/documentation/react/components/tooltip). ## Examples diff --git a/packages/react-core/src/helpers/OUIA/OUIA.md b/packages/react-core/src/helpers/OUIA/OUIA.md index 237a1b3556e..da9e4e5650c 100644 --- a/packages/react-core/src/helpers/OUIA/OUIA.md +++ b/packages/react-core/src/helpers/OUIA/OUIA.md @@ -65,15 +65,15 @@ import { Button } from '@patternfly/react-core'; * [Dropdown](/components/menus/dropdown) * [DropdownItem](/components/menus/dropdown) * [FormSelect](/components/forms/form-select) -* [Menu](/components/menu/menu) +* [Menu](/components/menus/menu) * [Modal](/components/modal) * [Navigation](/components/navigation) * [NavExpandable](/components/navigation) * [NavItem](/components/navigation) -* [OptionsMenu](/components/menu/options-menu) +* [OptionsMenu](/components/menus/options-menu) * [Pagination](/components/pagination) * [Radio](/components/forms/radio) -* [Select](/components/menu/select) +* [Select](/components/menus/select) * [Switch](/components/switch) * [TabContent](/components/tabs) * [Tabs](/components/tabs) From 12b605976234e2ceb201ce30d20721f8cfef5fae Mon Sep 17 00:00:00 2001 From: Erin Donehoo Date: Tue, 27 Jun 2023 16:24:14 -0400 Subject: [PATCH 4/7] Updates application launcher links. --- .../ApplicationLauncher/examples/ApplicationLauncher.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/react-core/src/deprecated/components/ApplicationLauncher/examples/ApplicationLauncher.md b/packages/react-core/src/deprecated/components/ApplicationLauncher/examples/ApplicationLauncher.md index 7fe793adac2..182e716b00b 100644 --- a/packages/react-core/src/deprecated/components/ApplicationLauncher/examples/ApplicationLauncher.md +++ b/packages/react-core/src/deprecated/components/ApplicationLauncher/examples/ApplicationLauncher.md @@ -13,8 +13,8 @@ import HelpIcon from '@patternfly/react-icons/dist/esm/icons/help-icon'; import { Link } from '@reach/router'; import pfLogoSm from './pf-logo-small.svg'; -Note: Application launcher is built on Dropdown, for extended API go to [Dropdown](/documentation/react/components/menus/dropdown) documentation. -To add a tooltip, use the `tooltip` prop and optionally add more tooltip props by using `tooltipProps`. For more tooltip information go to [Tooltip](/documentation/react/components/tooltip). +Note: Application launcher is built on Dropdown, for extended API go to [Dropdown](/components/menus/dropdown) documentation. +To add a tooltip, use the `tooltip` prop and optionally add more tooltip props by using `tooltipProps`. For more tooltip information go to [Tooltip](/components/tooltip). ## Examples From 015d94b3775a34f486384f6c799e3375a523b52b Mon Sep 17 00:00:00 2001 From: Erin Donehoo Date: Wed, 28 Jun 2023 11:43:16 -0400 Subject: [PATCH 5/7] Remove deprecated components. --- packages/react-core/src/helpers/OUIA/OUIA.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/packages/react-core/src/helpers/OUIA/OUIA.md b/packages/react-core/src/helpers/OUIA/OUIA.md index da9e4e5650c..efe54219295 100644 --- a/packages/react-core/src/helpers/OUIA/OUIA.md +++ b/packages/react-core/src/helpers/OUIA/OUIA.md @@ -61,7 +61,6 @@ import { Button } from '@patternfly/react-core'; * [Card](/components/card) * [Checkbox](/components/forms/checkbox) * [Chip](/components/chip) -* [ContextSelector](/components/menus/context-selector) * [Dropdown](/components/menus/dropdown) * [DropdownItem](/components/menus/dropdown) * [FormSelect](/components/forms/form-select) @@ -70,7 +69,6 @@ import { Button } from '@patternfly/react-core'; * [Navigation](/components/navigation) * [NavExpandable](/components/navigation) * [NavItem](/components/navigation) -* [OptionsMenu](/components/menus/options-menu) * [Pagination](/components/pagination) * [Radio](/components/forms/radio) * [Select](/components/menus/select) From 89491eb6258819dd584d81fe8bf4b6607a5418f5 Mon Sep 17 00:00:00 2001 From: nicolethoen Date: Mon, 3 Jul 2023 10:51:56 -0400 Subject: [PATCH 6/7] fix captialization in app launcher --- .../ApplicationLauncher/examples/ApplicationLauncher.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/react-core/src/deprecated/components/ApplicationLauncher/examples/ApplicationLauncher.md b/packages/react-core/src/deprecated/components/ApplicationLauncher/examples/ApplicationLauncher.md index 182e716b00b..36d14b01129 100644 --- a/packages/react-core/src/deprecated/components/ApplicationLauncher/examples/ApplicationLauncher.md +++ b/packages/react-core/src/deprecated/components/ApplicationLauncher/examples/ApplicationLauncher.md @@ -13,7 +13,7 @@ import HelpIcon from '@patternfly/react-icons/dist/esm/icons/help-icon'; import { Link } from '@reach/router'; import pfLogoSm from './pf-logo-small.svg'; -Note: Application launcher is built on Dropdown, for extended API go to [Dropdown](/components/menus/dropdown) documentation. +Note: Application launcher is built on dropdown, for extended API go to [dropdown](/components/menus/dropdown) documentation. To add a tooltip, use the `tooltip` prop and optionally add more tooltip props by using `tooltipProps`. For more tooltip information go to [Tooltip](/components/tooltip). ## Examples From e06c6ca86d87fb889249bad2b94e406f5948aae0 Mon Sep 17 00:00:00 2001 From: nicolethoen Date: Mon, 3 Jul 2023 10:53:16 -0400 Subject: [PATCH 7/7] fix captialization in app launcher --- .../ApplicationLauncher/examples/ApplicationLauncher.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/react-core/src/deprecated/components/ApplicationLauncher/examples/ApplicationLauncher.md b/packages/react-core/src/deprecated/components/ApplicationLauncher/examples/ApplicationLauncher.md index 36d14b01129..00792444de8 100644 --- a/packages/react-core/src/deprecated/components/ApplicationLauncher/examples/ApplicationLauncher.md +++ b/packages/react-core/src/deprecated/components/ApplicationLauncher/examples/ApplicationLauncher.md @@ -14,7 +14,7 @@ import { Link } from '@reach/router'; import pfLogoSm from './pf-logo-small.svg'; Note: Application launcher is built on dropdown, for extended API go to [dropdown](/components/menus/dropdown) documentation. -To add a tooltip, use the `tooltip` prop and optionally add more tooltip props by using `tooltipProps`. For more tooltip information go to [Tooltip](/components/tooltip). +To add a tooltip, use the `tooltip` prop and optionally add more tooltip props by using `tooltipProps`. For more tooltip information go to [tooltip](/components/tooltip). ## Examples