@oaknational/oak-components 2.19.2 → 2.20.0

package/dist/types.d.ts

@@ -5291,11 +5291,9 @@ type OakULProps = OakBoxProps & OakFlexProps & {
  * */
 declare const OakUL: styled_components.StyledComponent<"ul", styled_components.DefaultTheme, OakULProps, never>;
 
-type UnstyledChevronAccordionProps = {
+type UnstyledChevronAccordionCommonProps = {
     /** The header of the accordion. */
     header: ReactNode;
-    /** Whether the accordion should be open initially. */
-    isInitiallyOpen?: boolean;
     /** The content of the accordion. */
     content: ReactNode;
     /** Optional subheader to display above the fold. */
@@ -5307,13 +5305,29 @@ type UnstyledChevronAccordionProps = {
     /** Aria label for the button when the accordion is closed. */
     ariaLabelClose?: string;
 } & FlexStyleProps & OakBoxProps & ColorStyleProps;
+type UnstyledChevronAccordionUncontrolledProps = {
+    /** Whether the accordion should be open initially. Uncontrolled usage only. */
+    isInitiallyOpen?: boolean;
+    isOpen?: never;
+    onOpenChange?: never;
+};
+type UnstyledChevronAccordionControlledProps = {
+    isInitiallyOpen?: never;
+    /** Controlled open state. Must be paired with `onOpenChange`. */
+    isOpen: boolean;
+    /** Called when the user toggles the accordion. Required when `isOpen` is provided. */
+    onOpenChange: (open: boolean) => void;
+};
+type UnstyledChevronAccordionProps = UnstyledChevronAccordionCommonProps & (UnstyledChevronAccordionUncontrolledProps | UnstyledChevronAccordionControlledProps);
 /**
  * - UnstyledChevronAccordion has a chevron icon that rotates when the accordion is open.
  * - Unlike InternalChevronAccordion, it has no border effects for hover or focus states.
  * - Only the chevron is interactive so as to allow interactive elements to be placed in the header.
  * - The intention is for these to be added by consuming components as needed.
+ * - Can be used as an uncontrolled component (via `isInitiallyOpen`) or as a
+ *   controlled component (via `isOpen` + `onOpenChange`).
  */
-declare const UnstyledChevronAccordion: ({ isInitiallyOpen, ...props }: UnstyledChevronAccordionProps) => React__default.JSX.Element;
+declare const UnstyledChevronAccordion: (props: UnstyledChevronAccordionProps) => React__default.JSX.Element;
 
 /**
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oaknational/oak-components",
-  "version": "2.19.2",
+  "version": "2.20.0",
   "licence": "MIT",
   "description": "Shared components for Oak applications",
   "main": "dist/cjs/index.js",