fix: Accordion release fixes #7391

reidbarber · 2024-11-18T23:58:06Z

Updates v3 DisclosureHeader to be DisclosureTitle to match S2 API
Updates S2 Disclosure JSDoc
Remove controlled stories from S2 Accordion storybook docs build

✅ Pull Request Checklist:

Included link to corresponding React Spectrum GitHub Issue.
Added/updated unit tests and storybook for this change (for new code or code which already has tests).
Filled out test instructions.
Updated documentation (if it already exists for this component).
Looked at the Accessibility Practices for this feature - Aria Practices

📝 Test Instructions:

🧢 Your Project:

rspbot · 2024-11-19T00:05:52Z

Build successful! 🎉

packages/@react-spectrum/accordion/docs/Accordion.mdx

rspbot · 2024-11-19T01:12:13Z

Build successful! 🎉

rspbot · 2024-11-19T01:12:14Z

## API Changes

@react-spectrum/accordion

/@react-spectrum/accordion:DisclosureHeader

-DisclosureHeader {
-  UNSAFE_className?: string
-  UNSAFE_style?: CSSProperties
-  alignSelf?: Responsive<'auto' | 'normal' | 'start' | 'end' | 'center' | 'flex-start' | 'flex-end' | 'self-start' | 'self-end' | 'stretch'>
-  aria-describedby?: string
-  aria-details?: string
-  aria-label?: string
-  aria-labelledby?: string
-  bottom?: Responsive<DimensionValue>
-  children: React.ReactNode
-  end?: Responsive<DimensionValue>
-  flex?: Responsive<string | number | boolean>
-  flexBasis?: Responsive<number | string>
-  flexGrow?: Responsive<number>
-  flexShrink?: Responsive<number>
-  gridArea?: Responsive<string>
-  gridColumn?: Responsive<string>
-  gridColumnEnd?: Responsive<string>
-  gridColumnStart?: Responsive<string>
-  gridRow?: Responsive<string>
-  gridRowEnd?: Responsive<string>
-  gridRowStart?: Responsive<string>
-  height?: Responsive<DimensionValue>
-  id?: string
-  isHidden?: Responsive<boolean>
-  justifySelf?: Responsive<'auto' | 'normal' | 'start' | 'end' | 'flex-start' | 'flex-end' | 'self-start' | 'self-end' | 'center' | 'left' | 'right' | 'stretch'>
-  left?: Responsive<DimensionValue>
-  level?: number = 3
-  margin?: Responsive<DimensionValue>
-  marginBottom?: Responsive<DimensionValue>
-  marginEnd?: Responsive<DimensionValue>
-  marginStart?: Responsive<DimensionValue>
-  marginTop?: Responsive<DimensionValue>
-  marginX?: Responsive<DimensionValue>
-  marginY?: Responsive<DimensionValue>
-  maxHeight?: Responsive<DimensionValue>
-  maxWidth?: Responsive<DimensionValue>
-  minHeight?: Responsive<DimensionValue>
-  minWidth?: Responsive<DimensionValue>
-  order?: Responsive<number>
-  position?: Responsive<'static' | 'relative' | 'absolute' | 'fixed' | 'sticky'>
-  right?: Responsive<DimensionValue>
-  start?: Responsive<DimensionValue>
-  top?: Responsive<DimensionValue>
-  width?: Responsive<DimensionValue>
-  zIndex?: Responsive<number>
-}

/@react-spectrum/accordion:SpectrumDisclosureHeaderProps

-SpectrumDisclosureHeaderProps {
-  UNSAFE_className?: string
-  UNSAFE_style?: CSSProperties
-  alignSelf?: Responsive<'auto' | 'normal' | 'start' | 'end' | 'center' | 'flex-start' | 'flex-end' | 'self-start' | 'self-end' | 'stretch'>
-  aria-describedby?: string
-  aria-details?: string
-  aria-label?: string
-  aria-labelledby?: string
-  bottom?: Responsive<DimensionValue>
-  children: React.ReactNode
-  end?: Responsive<DimensionValue>
-  flex?: Responsive<string | number | boolean>
-  flexBasis?: Responsive<number | string>
-  flexGrow?: Responsive<number>
-  flexShrink?: Responsive<number>
-  gridArea?: Responsive<string>
-  gridColumn?: Responsive<string>
-  gridColumnEnd?: Responsive<string>
-  gridColumnStart?: Responsive<string>
-  gridRow?: Responsive<string>
-  gridRowEnd?: Responsive<string>
-  gridRowStart?: Responsive<string>
-  height?: Responsive<DimensionValue>
-  id?: string
-  isHidden?: Responsive<boolean>
-  justifySelf?: Responsive<'auto' | 'normal' | 'start' | 'end' | 'flex-start' | 'flex-end' | 'self-start' | 'self-end' | 'center' | 'left' | 'right' | 'stretch'>
-  left?: Responsive<DimensionValue>
-  level?: number = 3
-  margin?: Responsive<DimensionValue>
-  marginBottom?: Responsive<DimensionValue>
-  marginEnd?: Responsive<DimensionValue>
-  marginStart?: Responsive<DimensionValue>
-  marginTop?: Responsive<DimensionValue>
-  marginX?: Responsive<DimensionValue>
-  marginY?: Responsive<DimensionValue>
-  maxHeight?: Responsive<DimensionValue>
-  maxWidth?: Responsive<DimensionValue>
-  minHeight?: Responsive<DimensionValue>
-  minWidth?: Responsive<DimensionValue>
-  order?: Responsive<number>
-  position?: Responsive<'static' | 'relative' | 'absolute' | 'fixed' | 'sticky'>
-  right?: Responsive<DimensionValue>
-  start?: Responsive<DimensionValue>
-  top?: Responsive<DimensionValue>
-  width?: Responsive<DimensionValue>
-  zIndex?: Responsive<number>
-}

/@react-spectrum/accordion:DisclosureTitle

+DisclosureTitle {
+  UNSAFE_className?: string
+  UNSAFE_style?: CSSProperties
+  alignSelf?: Responsive<'auto' | 'normal' | 'start' | 'end' | 'center' | 'flex-start' | 'flex-end' | 'self-start' | 'self-end' | 'stretch'>
+  aria-describedby?: string
+  aria-details?: string
+  aria-label?: string
+  aria-labelledby?: string
+  bottom?: Responsive<DimensionValue>
+  children: React.ReactNode
+  end?: Responsive<DimensionValue>
+  flex?: Responsive<string | number | boolean>
+  flexBasis?: Responsive<number | string>
+  flexGrow?: Responsive<number>
+  flexShrink?: Responsive<number>
+  gridArea?: Responsive<string>
+  gridColumn?: Responsive<string>
+  gridColumnEnd?: Responsive<string>
+  gridColumnStart?: Responsive<string>
+  gridRow?: Responsive<string>
+  gridRowEnd?: Responsive<string>
+  gridRowStart?: Responsive<string>
+  height?: Responsive<DimensionValue>
+  id?: string
+  isHidden?: Responsive<boolean>
+  justifySelf?: Responsive<'auto' | 'normal' | 'start' | 'end' | 'flex-start' | 'flex-end' | 'self-start' | 'self-end' | 'center' | 'left' | 'right' | 'stretch'>
+  left?: Responsive<DimensionValue>
+  level?: number = 3
+  margin?: Responsive<DimensionValue>
+  marginBottom?: Responsive<DimensionValue>
+  marginEnd?: Responsive<DimensionValue>
+  marginStart?: Responsive<DimensionValue>
+  marginTop?: Responsive<DimensionValue>
+  marginX?: Responsive<DimensionValue>
+  marginY?: Responsive<DimensionValue>
+  maxHeight?: Responsive<DimensionValue>
+  maxWidth?: Responsive<DimensionValue>
+  minHeight?: Responsive<DimensionValue>
+  minWidth?: Responsive<DimensionValue>
+  order?: Responsive<number>
+  position?: Responsive<'static' | 'relative' | 'absolute' | 'fixed' | 'sticky'>
+  right?: Responsive<DimensionValue>
+  start?: Responsive<DimensionValue>
+  top?: Responsive<DimensionValue>
+  width?: Responsive<DimensionValue>
+  zIndex?: Responsive<number>
+}

/@react-spectrum/accordion:SpectrumDisclosureTitleProps

+SpectrumDisclosureTitleProps {
+  UNSAFE_className?: string
+  UNSAFE_style?: CSSProperties
+  alignSelf?: Responsive<'auto' | 'normal' | 'start' | 'end' | 'center' | 'flex-start' | 'flex-end' | 'self-start' | 'self-end' | 'stretch'>
+  aria-describedby?: string
+  aria-details?: string
+  aria-label?: string
+  aria-labelledby?: string
+  bottom?: Responsive<DimensionValue>
+  children: React.ReactNode
+  end?: Responsive<DimensionValue>
+  flex?: Responsive<string | number | boolean>
+  flexBasis?: Responsive<number | string>
+  flexGrow?: Responsive<number>
+  flexShrink?: Responsive<number>
+  gridArea?: Responsive<string>
+  gridColumn?: Responsive<string>
+  gridColumnEnd?: Responsive<string>
+  gridColumnStart?: Responsive<string>
+  gridRow?: Responsive<string>
+  gridRowEnd?: Responsive<string>
+  gridRowStart?: Responsive<string>
+  height?: Responsive<DimensionValue>
+  id?: string
+  isHidden?: Responsive<boolean>
+  justifySelf?: Responsive<'auto' | 'normal' | 'start' | 'end' | 'flex-start' | 'flex-end' | 'self-start' | 'self-end' | 'center' | 'left' | 'right' | 'stretch'>
+  left?: Responsive<DimensionValue>
+  level?: number = 3
+  margin?: Responsive<DimensionValue>
+  marginBottom?: Responsive<DimensionValue>
+  marginEnd?: Responsive<DimensionValue>
+  marginStart?: Responsive<DimensionValue>
+  marginTop?: Responsive<DimensionValue>
+  marginX?: Responsive<DimensionValue>
+  marginY?: Responsive<DimensionValue>
+  maxHeight?: Responsive<DimensionValue>
+  maxWidth?: Responsive<DimensionValue>
+  minHeight?: Responsive<DimensionValue>
+  minWidth?: Responsive<DimensionValue>
+  order?: Responsive<number>
+  position?: Responsive<'static' | 'relative' | 'absolute' | 'fixed' | 'sticky'>
+  right?: Responsive<DimensionValue>
+  start?: Responsive<DimensionValue>
+  top?: Responsive<DimensionValue>
+  width?: Responsive<DimensionValue>
+  zIndex?: Responsive<number>
+}

reidbarber added 3 commits November 18, 2024 17:43

update DisclosureHeader to DisclosureTitle in v3

4abe3f7

update S2 Disclosure JSDoc

de3557e

disable controlled S2 Accordion stories in docs

c72aa06

snowystinger added the release label Nov 19, 2024

snowystinger previously approved these changes Nov 19, 2024

View reviewed changes

LFDanLu reviewed Nov 19, 2024

View reviewed changes

packages/@react-spectrum/accordion/docs/Accordion.mdx Outdated Show resolved Hide resolved

LFDanLu dismissed snowystinger’s stale review via 94c9957 November 19, 2024 01:02

Update packages/@react-spectrum/accordion/docs/Accordion.mdx

94c9957

LFDanLu approved these changes Nov 19, 2024

View reviewed changes

reidbarber enabled auto-merge November 19, 2024 01:21

snowystinger approved these changes Nov 19, 2024

View reviewed changes

reidbarber added this pull request to the merge queue Nov 19, 2024

Merged via the queue into main with commit 0ab0544 Nov 19, 2024
30 checks passed

reidbarber deleted the accordion-v3-release-fixes branch November 19, 2024 01:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Accordion release fixes #7391

fix: Accordion release fixes #7391

reidbarber commented Nov 18, 2024

rspbot commented Nov 19, 2024

rspbot commented Nov 19, 2024

rspbot commented Nov 19, 2024

fix: Accordion release fixes #7391

fix: Accordion release fixes #7391

Conversation

reidbarber commented Nov 18, 2024

✅ Pull Request Checklist:

📝 Test Instructions:

🧢 Your Project:

rspbot commented Nov 19, 2024

rspbot commented Nov 19, 2024

rspbot commented Nov 19, 2024

@react-spectrum/accordion

/@react-spectrum/accordion:DisclosureHeader

/@react-spectrum/accordion:SpectrumDisclosureHeaderProps

/@react-spectrum/accordion:DisclosureTitle

/@react-spectrum/accordion:SpectrumDisclosureTitleProps