diff --git a/packages/documentation-site/package.json b/packages/documentation-site/package.json index 134e86d8ae..7fb8941c4c 100644 --- a/packages/documentation-site/package.json +++ b/packages/documentation-site/package.json @@ -17,7 +17,7 @@ "screenshots": "pf-docs-framework screenshots" }, "dependencies": { - "@patternfly/documentation-framework": "6.0.0-alpha.90", + "@patternfly/documentation-framework": "6.0.0-alpha.94", "@patternfly/react-catalog-view-extension": "6.0.0-alpha.7", "@patternfly/react-console": "6.0.0-alpha.5", "@patternfly/react-docs": "7.0.0-alpha.113", diff --git a/packages/documentation-site/patternfly-docs/content/get-started/release-notes-data.js b/packages/documentation-site/patternfly-docs/content/get-started/release-notes-data.js index cbd24d70cb..961b3d51e7 100644 --- a/packages/documentation-site/patternfly-docs/content/get-started/release-notes-data.js +++ b/packages/documentation-site/patternfly-docs/content/get-started/release-notes-data.js @@ -1,5 +1,5 @@ import React from "react"; -import { CodeBlock, CodeBlockCode, Content, ContentVariants } from '@patternfly/react-core'; +import { CodeBlock, CodeBlockCode, Content, ContentVariants, Button } from '@patternfly/react-core'; import { Table, Tbody, @@ -36,5113 +36,3249 @@ const pagePropsTableRows = [ export const releaseNotes = [ { - component: "Card", - description: "Deprecated various properties.", - pullRequestURL: "https://github.com/patternfly/patternfly-react/pull/9092", + component: "Accordion content", + description: + "The `isHidden` prop has been removed from AccordionContent, as its visibility will now be set automatically based on the `isExpanded` prop on AccordionItem.", + pullRequestURL: "https://github.com/patternfly/patternfly-react/pull/9876", + repo: "React", + fixedWithCodeMod: true, + title: "accordionContent-remove-isHidden-prop", details: ( - Deprecated the following properties: - - isSelectableRaised - isDisabledRaised - hasSelectableInput - selectableInputAriaLabel - selectableInputAriaLabel - - - We recommend using our new implementation of clickable and selectable cards instead. Codemods will raise a warning, but can provide fixes when using the `isSelectableRaised` or `isDisabledRaised` properties. - - Example in +

Codemods will make the following updates:

+

Example in

- {` -`} + {`import { AccordionContent } from "@patternfly/react-core"; + +export const AccordionContentRemoveIsHiddenPropInput = () => ( + +);`} - Example out +

Example out

- {` -`} + {`import { AccordionContent } from "@patternfly/react-core"; + +export const AccordionContentRemoveIsHiddenPropInput = () => ( + +);`}
), + }, + { + component: "Accordion item", + description: + "The markup for AccordionItem has been updated, and it now renders a `div` element as a wrapper.", + pullRequestURL: "https://github.com/patternfly/patternfly-react/pull/9876", repo: "React", - fixedWithCodeMod: true - }, { - component: "Card", - description: "Removed the deprecated `isHoverable` property.", - pullRequestURL: "https://github.com/patternfly/patternfly-react/pull/8196", + fixedWithCodeMod: false, + title: "accordionItem-warn-update-markup", + }, + { + component: "Accordion toggle", + description: + "The `isExpanded` prop for AccordionToggle has been moved to AccordionItem.", + pullRequestURL: "https://github.com/patternfly/patternfly-react/pull/9876", repo: "React", fixedWithCodeMod: true, - details:( + title: "accordionToggle-move-isExpanded-prop", + details: ( - Codemods will make the following updates: - Example in +

Codemods will make the following updates:

+

Example in

- {``} + {`import { AccordionItem, AccordionToggle } from "@patternfly/react-core"; + +export const AccordionToggleMoveIsExpandedPropInput = () => ( + + + +);`} - Example out +

Example out

- {``} + {`import { AccordionItem, AccordionToggle } from "@patternfly/react-core"; + +export const AccordionToggleMoveIsExpandedPropInput = () => ( + + + +);`}
- ) - }, { - component: "Card", - description: "Reordered `onSelectableInputChange` event parameters.", - pullRequestURL: "https://github.com/patternfly/patternfly-react/pull/8752", + ), + }, + { + component: "Avatar", + pullRequestURL:"https://github.com/patternfly/patternfly-react/pull/9881", + description: + "The `border` prop has been removed from Avatar since theming is not longer handled React-side. We recommend using the `isBordered` prop instead to add a border to Avatar.", repo: "React", fixedWithCodeMod: true, - details:( + title: "avatar-replace-border-for-isBordered", + details: ( - Codemods will make the following updates: - Example in +

Codemods will make the following updates:

+

Example in

- {` handler(id)} /> -const handler1 = (id) => {}; - -function handler2(id) {}; -`} + {`import { Avatar } from '@patternfly/react-core'; + +export const AvatarReplaceBorderForIsBorderedInput = () => ( + +);`} - Example out +

Example out

- {` handler(id)} /> -const handler1 = (_event, id) => {}; - -function handler2(_event, id) {}; -`} + {`import { Avatar } from '@patternfly/react-core'; + +export const AvatarReplaceBorderForIsBorderedInput = () => ( + +);`}
- ) - }, { - component: "Card", - description: "Updated the internal default value of the `component` property from 'article' to 'div'.", - pullRequestURL: "https://github.com/patternfly/patternfly-react/pull/8601", - repo: "React", - fixedWithCodeMod: false - }, { - component: "Card", - description: "`CardHeaderMain` and `CardActions` are no longer exported from PatternFly, and are instead rendered internally within the `CardHeader` sub-component. Any `CardHeaderMain` content and `CardActions` content or properties should be passed directly to `CardHeader` instead.", - pullRequestURL: "https://github.com/patternfly/patternfly-react/pull/8759", + ), + }, + { + component: "Banner", + description: + "The `variant` property has been removed from Banner. We recommend using our new `color` or `status` properties, depending on the original intent of the `variant` property. Codemods will either replace the `variant` property with the `color` property, or remove the `variant` property entirely, but additional updates may need to be made.", + pullRequestURL: "https://github.com/patternfly/patternfly-react/pull/9891", repo: "React", fixedWithCodeMod: true, + title: "banner-replace-variantProp", details: ( - Codemods will make the following updates: - Example in +

Codemods will make the following updates:

+

Example in

- {` - Header content - -`} + {`import { Banner } from "@patternfly/react-core"; + +export const BannerReplaceVariantPropInput = () => ( + <> + + + +);`} - Example out +

Example out

- {`, hasNoOffset: true, className: "test"}} > - Header content - -`} + {`import { Banner } from "@patternfly/react-core"; + +export const BannerReplaceVariantPropInput = () => ( + <> + + + +);`}
- ) - }, { - component: "Sidebar", - description: "Added the ability for a border to separate the sidebar panel and sidebar content.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5221", - details: "Allowed the sidebar component to support more flexible layouts by adding support for padding to be added to the sidebar panel and sidebar content elements.", - repo: "HTML/CSS", - fixedWithCodeMod: false - }, { - component: "Skip to content", - description: "Previously, the skip to content component classes were applied directly to the button classes to create the skip to content component. This pull request added a structural HTML element that wraps the component and serves as the parent element for the skip to content component.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5153", - repo: "HTML/CSS", - fixedWithCodeMod: false - }, { - component: "Spinner", - description: "Removed the legacy spinner variation in favor of the SVG spinner variation.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5468", - repo: "HTML/CSS", - fixedWithCodeMod: false - }, { - component: "Table", - description: "Renamed the table component's “sticky-column” element to “sticky-cell” to be more flexible in sticky positioning. Added support for a table column to be sticky to the right edge of the table instead of just the left.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5393", - repo: "HTML/CSS", - fixedWithCodeMod: false - }, { - component: "Table", - description: "Improved the alignment of the table action column by right-aligning the contents of the table action cell.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5400", - repo: "HTML/CSS", - fixedWithCodeMod: false - }, { - component: "Table", - description: "Added unique table component CSS class selectors to all elements of the table that previously did not have a class.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5558", - details: "For example, '' is now '', 'thead' is now ''", - repo: "HTML/CSS", - fixedWithCodeMod: false - }, { - component: "Table", - description: "Improved and updated the visual appearance of clickable rows.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5397", - details: "Renamed “hoverable” table rows to “clickable” to be more consistent with similar features in other components.", - repo: "HTML/CSS", - fixedWithCodeMod: false - }, { - component: "Tabs", - description: "Updated secondary tabs to have a border by default. This is more consistent with the presentation of primary tabs.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5171", - repo: "HTML/CSS", - fixedWithCodeMod: false - }, { - component: "Toolbar", - description: "Updated the default alignment of toolbar children to use baseline vertical alignment instead of center alignment, which improved the visual appearance of toolbar children of differing heights.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5201", - details: "Added modifiers to toolbar children to use center and baseline alignment. This is a non-breaking change - it just allows going back to the old default alignment of center, and specifying baseline on specific children.", - repo: "HTML/CSS", - fixedWithCodeMod: false - }, { - component: "Toolbar", - description: "Updated the default alignment to use top alignment.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5565", - details: "Added a modifier for children to use top alignment. This is a non-breaking change that just allows for the previously defined center and baseline alignments to be used, and for top alignment to be used on specific children.", - repo: "HTML/CSS", - fixedWithCodeMod: false - }, { - component: "Toolbar", - description: "Added a CSS row gap to wrapping toolbar items. Previously, items would wrap directly underneath items on the previous row, and this update added a visual spacer between wrapping rows.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5398", - repo: "HTML/CSS", - fixedWithCodeMod: false - }, { - component: "Toolbar", - description: "Improved the visual appearance of the expanded content element. This isn’t an enhancement, but was to fix a bug introduced in a previous pull request. This change makes breaking changes to CSS variables.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5611", - repo: "HTML/CSS", - fixedWithCodeMod: false - }, { - component: "Wizard", - description: "Updated the stacking context of structural elements within the wizard component so that elements from the wizard main content area are able to overflow and display on top of the wizard footer.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5533", - repo: "HTML/CSS", - fixedWithCodeMod: false - }, { - component: "Wizard", - description: "Refactored the popover component HTML to be more flexible and consistent with similarly structured components.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5389", - details: "Added a structural HTML element to the that is used to wrap the close button. Updated the wizard title to be more flexible.", - repo: "HTML/CSS", - fixedWithCodeMod: false - }, - { - component: "@All", - description: ( - <> - Removed unnecessary visibility{" "} - declaration that was paired with the use of the{" "} - display property to hide and show - elements. - - ), - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5209", - repo: "HTML/CSS", - fixedWithCodeMod: false, - }, - { - component: "@All", - description: - "Prefixed all of our public HTML classes (except for modifiers), CSS variables/custom properties, and SCSS variables/mixins/functions/placeholders with the PatternFly version number to avoid namespace conflicts.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5434", - repo: "HTML/CSS", - fixedWithCodeMod: false, - }, - { - component: "@All", - description: "Added transparent background to various buttons, other cleanup.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5379", - repo: "HTML/CSS", - fixedWithCodeMod: false, - }, - { - component: "@All", - description: ( - <> - Removed references to any fallback{" "} - .woff font files for text and icons. - - ), - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5435", - repo: "HTML/CSS", - fixedWithCodeMod: false, - }, - { - component: "@All", - description: ( - <> - Split the global reset styles into “normalize” and “reset”, which - can be uniquely disabled/enabled by setting{" "} - $pf-global--enable-reset and{" "} - $pf-global--enable-normalize. - - ), - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5435", - repo: "HTML/CSS", - fixedWithCodeMod: false, - }, - { - component: "@All", - description: ( - <> - Wrapped all global normalize and reset styles in{" "} - :where() to remove CSS specificity. - - ), - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5435", - repo: "HTML/CSS", - fixedWithCodeMod: false, - }, - { - component: "@All", - description: "Removed an old bootstrap variable mapping stylesheet.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5435", - repo: "HTML/CSS", - fixedWithCodeMod: false, - }, - { - component: "@All", - description: - "Removed card and button specific styles for use in dark and light blocks within components.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5435", - repo: "HTML/CSS", - fixedWithCodeMod: false, - }, - { - component: "@All", - description: ( - <> - Removed the SCSS variables{" "} - $pf-global--enable-shield and{" "} - $pf-global--load-pf-3. - - ), - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5435", - repo: "HTML/CSS", - fixedWithCodeMod: false, - }, - { - component: "@All", - description: "Renamed the global “default” status color to “custom”.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5418", - repo: "HTML/CSS", - fixedWithCodeMod: false, - }, - { - component: "@All", - description: - "Updated any use of a non-PatternFly component checkbox/radio input to use the standalone variation of the PatternFly check/radio component.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5355", - repo: "HTML/CSS", - fixedWithCodeMod: false, - }, - { - component: "@All", - description: "Fixed dark theme bugs.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5535", - repo: "HTML/CSS", - fixedWithCodeMod: false, - }, - { - component: "@All", - description: "Removed global “shield” CSS.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5339", - repo: "HTML/CSS", - fixedWithCodeMod: false, - }, - { - component: "@All", - description: ( - <> - Removed declaration setting font-size on HTML element and associated - SCSS var{" "} - $pf-global--unset-root-font-size. - ), - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5339", - repo: "HTML/CSS", - fixedWithCodeMod: false, - }, - { - component: "@All", - description: "Updated all of our RedHatFont files to the latest versions.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5503", - repo: "HTML/CSS", - fixedWithCodeMod: false, - }, - { - component: "@All", - description: - "Renamed the global variables for font family variations, and global class to opt-in to the variable font.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5503", - repo: "HTML/CSS", - fixedWithCodeMod: false, - }, - { - component: "@All", - description: "Removed support for the legacy overpass font.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5169", - repo: "HTML/CSS", - fixedWithCodeMod: false, - }, - { - component: "About modal", - description: "Removed the default background image.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5530", - repo: "HTML/CSS", - fixedWithCodeMod: false, - }, - { - component: "About modal", - description: - "Refactored the about modal box to be placed inside of the modal component.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5216", - repo: "HTML/CSS", - fixedWithCodeMod: false, - }, - { - component: "About modal", - description: "Updated to support new design of background image.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5328", - repo: "HTML/CSS", - fixedWithCodeMod: false, - }, - { - component: "Background image", - description: "Removed the default background image.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5530", - repo: "HTML/CSS", - fixedWithCodeMod: false, - }, - { - component: "Background image", - description: "Updated to support new design of background image.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5328", - repo: "HTML/CSS", - fixedWithCodeMod: false, - }, - { - component: "Accordion", - description: - "Renamed the accordion expandable content component from “expanded-content” to “expandable-content”.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5180", - repo: "HTML/CSS", - fixedWithCodeMod: false, }, { - component: "Banner", - description: - "Renamed status variations (such as “success”, “warning”, and “danger”) to be more generic color variations (such as “green”, “gold”, and “red”).", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5408", - repo: "HTML/CSS", - fixedWithCodeMod: false, - }, - { - component: "Card", - description: "Updated design for selectable and clickable cards.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5409", - repo: "HTML/CSS", - fixedWithCodeMod: false, - }, - { - component: "Card", - description: - "Refactored the card header code to be more flexible and improved the visual appearance of card header items.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5280", - repo: "HTML/CSS", - fixedWithCodeMod: false, - }, - { - component: "Card", - description: - "Refactored the card title to be more flexible, and changed the default card title font weight to “normal”.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5363", - repo: "HTML/CSS", - fixedWithCodeMod: false, - }, - { - component: "Check", + component: "Button", description: - "Updated description and body elements to occupy the available width.", - pullRequestURL: "https://github.com/patternfly/patternfly/pull/5233", - repo: "HTML/CSS", - fixedWithCodeMod: false, - }, { - component: "Divider", - description: (<>Replaced the isVertical flag with the orientation property that can define verticality on different breakpoints.), - pullRequestURL: "https://github.com/patternfly/patternfly-react/pull/8199", + 'Icons must now be passed to the `icon` prop of Button instead of as children. Codemods will only update instances of a Button with `variant="plain"` passed in, but you must ensure you are only passing an icon in such instances before running the fix.', + pullRequestURL: "https://github.com/patternfly/patternfly-react/pull/10663", + repo: "React", + fixedWithCodeMod: true, + title: "button-moveIcons-icon-prop", details: ( - Example in +

Codemods will make the following updates:

+

Example in

- {``} + {`import { Button, Icon } from "@patternfly/react-core"; +import { SomeIcon } from "@patternfly/react-icons"; + +export const ButtonMoveIconsIconPropInput = () => ( + <> + + + + +);`} - Example out +

Example out

- {``} + {`import { Button, Icon } from "@patternfly/react-core"; +import { SomeIcon } from "@patternfly/react-icons"; + +export const ButtonMoveIconsIconPropInput = () => ( + <> + + + + +);`}
), - repo: "React", - fixedWithCodeMod: true }, { - component: "Drawer", - description: (<>The onResize property in DrawerPanelContent to take the event as its first parameter. Handlers may require an update.), - pullRequestURL: "https://github.com/patternfly/patternfly-react/pull/8736", + component: "Button", + description: "isActive prop for Button has been renamed to isClicked", + pullRequestURL: "https://github.com/patternfly/patternfly-react/pull/9934", + repo: "React", + fixedWithCodeMod: true, + title: "button-rename-isActive", details: ( - Example in +

Codemods will make the following updates:

+

Example in

- {` onChange(checked)} /> - - const onResize1 = (width, id) => {}; - - - function onResize2(width, id) {}; - `} + {`import { Button } from "@patternfly/react-core"; + +export const ButtonRenameIsActiveInput = () =>