diff --git a/example/storybook-nativewind/src/components/Accordion/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Accordion/index.nw.stories.mdx index 15874de849..42564905e5 100644 --- a/example/storybook-nativewind/src/components/Accordion/index.nw.stories.mdx +++ b/example/storybook-nativewind/src/components/Accordion/index.nw.stories.mdx @@ -7,15 +7,1164 @@ pageTitle: Accordion pageDescription: The Accordion component is a versatile and interactive user interface element, designed to efficiently organize and present content in a compact space. -showHeader: false - -tag: coming soon +showHeader: true --- import { Meta } from '@storybook/addon-docs'; +import { + Accordion, + AccordionItem, + AccordionHeader, + AccordionTrigger, + AccordionTitleText, + AccordionIcon, + AccordionContent, + AccordionContentText, + Divider, + ChevronDownIcon, + ChevronUpIcon, +} from '../../core-components/nativewind'; +import { + PlusIcon, MinusIcon +} from 'lucide-react-native' +import { + AppProvider, + CodePreview, + Table, + TableContainer, + InlineCode, + AddIcon, + InfoIcon, + Alert, +} from '@gluestack/design-system'; +import { transformedCode } from '../../utils'; +import { CollapsibleCode } from '@gluestack/design-system'; +import Wrapper from '../../core-components/nativewind/Wrapper'; -# Accordion +This is an illustration of **Accordion** component. + +<> + + + + + {({ isExpanded }) => { + return ( + <> + + How do I place an order? + + {isExpanded ? ( + + ) : ( + + )} + + ); + }} + + + + + To place an order, simply select the products you want, proceed to + checkout, provide shipping and payment information, and finalize + your purchase. + + + + + + + {({ isExpanded }) => { + return ( + <> + + What payment methods do you accept? + + {isExpanded ? ( + + ) : ( + + )} + + ); + }} + + + + + We accept all major credit cards, including Visa, Mastercard, and + American Express. We also support payments through PayPal. + + + + + `, + transformCode: (code) => { + return transformedCode(code); + }, + scope: { + Accordion, + AccordionItem, + AccordionHeader, + AccordionTrigger, + AccordionTitleText, + AccordionIcon, + AccordionContent, + AccordionContentText, + ChevronDownIcon, + ChevronUpIcon, + Wrapper, + }, + argsType: { + size: { + control: 'select', + options: ['sm', 'md', 'lg'], + default: 'md', + }, + variant: { + control: 'select', + options: ['filled', 'unfilled'], + default: 'filled', + }, + type: { + control: 'select', + options: ['single', 'multiple'], + default: 'single', + }, + isCollapsible: { + control: 'boolean', + default: true, + }, + isDisabled: { + control: 'boolean', + }, + }, + }} + /> + + +
+ +## Installation + +### Step 1: Install the following dependencies: + +```bash + +npm i @gluestack-ui/accordion + +``` + +### Step 2: Copy and paste the following code into your project. + + + ```jsx %%-- File: core-components/nativewind/accordion/index.tsx --%% ``` + + +### Step 3: Update the import paths to match your project setup. + +## API Reference + +To use this component in your project, include the following import statement in your file. + +```jsx +import { + Accordion, + AccordionItem, + AccordionHeader, + AccordionTrigger, + AccordionTitleText, + AccordionContent, + AccordionContentText, + AccordionIcon, +} from '@/components/ui/accordion'; +``` + +```jsx +export default () => ( + + + + + + + + + + + + + +); +``` +### Component Props + +This section provides a comprehensive reference list for the component props, detailing descriptions, properties, types, and default behavior for easy project integration. + +#### Accordion + +It inherits all the properties of React Native's [View](https://reactnative.dev/docs/view) component. + +<> + + + + + + Prop + + + Type + + + Default + + + Description + + + + + + + + type + + + + "single" | "multiple" + + + "single" + + + {`Determines whether one or multiple items can be opened at the same time.`} + + + + + + isCollapsible + + + + boolean + + + true + + + {`When type is "single" or "multiple", allows closing content when clicking trigger for an open item.`} + + + + + + defaultValue + + + + string[] + + + [] + + + {`The value of the item to expand when initially rendered when type is "single" or "multiple".`} + + + + + + value + + + + string[] + + + [] + + + {`The controlled value of the item to expand when type is "single" or "multiple".`} + + + + + + onValueChange + + + + function + + + - + + + {`Event handler called when the expanded state of an item changes and type is "single" or "multiple".`} + + + + + + isDisabled + + + + boolean + + + false + + + {`When true, prevents the user from interacting with the accordion and all its items.`} + + + +
+
+ + +#### AccordionItem + +Contains all the parts of a collapsible section. + +<> + + + + + + Prop + + + Type + + + Default + + + Description + + + + + + + + value + + + + string + + + - + + + {`The controlled value of the item to expand when type is "single" or "multiple". Must be used in conjunction with onValueChange.This is a mandatory prop.`} + + + + + + isDisabled + + + + boolean + + + false + + + {`When true, prevents the user from interacting with the accordion and all its items.`} + + + +
+
+ + +#### AccordionHeader + +Wraps an `Accordion.Trigger`. It inherits all the properties of @expo/html-elements's [H3](https://www.npmjs.com/package/@expo/html-elements#h3) on web and It inherits all the properties of react native's [View](https://reactnative.dev/docs/view) on native. Use the as prop to update it to the appropriate heading level for your page. + + +#### AccordionTrigger + +Toggles the collapsed state of its associated item. It inherits all the properties of react native's [Pressable](https://reactnative.dev/docs/pressable). It should be nested inside of an `Accordion.Header`. + +#### AccordionTitleText + +It inherits all the properties of React Native's [Text](https://reactnative.dev/docs/text) component. + +#### AccordionIcon + +Contains all Icon related layout style props and actions.It inherits all the properties of React Native's [View](https://reactnative.dev/docs/view) component. + +#### AccordionContent + +Contains all the collapsible content for an item. It inherits all the properties of React Native [View](https://reactnative.dev/docs/view) component. + +#### AccordionContentText + +It inherits all the properties of React Native's [Text](https://reactnative.dev/docs/text) component. + +### Accessibility + +Adheres to the Accordion [WAI-ARIA design pattern](https://www.w3.org/WAI/ARIA/apg/patterns/accordion/examples/accordion/). + + +We have outlined the various features that ensure the Accordion component is accessible to all users, including those with disabilities. These features help ensure that your application is inclusive and meets accessibility standards. + +- Header is h3 tag on web. +- aria-expanded is "true" when the Accordion Content is visible, otherwise false. +- role is set to "region" for the currently expanded accordion panel. +- aria-controls points to the id of the Accordion Content. +- aria-labelledby references the accordion header button that expands and collapses the region. + +### Keyboard Interactions + +- `Space` - When focus is on an Accordion.Trigger of a collapsed section, expands the section. +- `Enter` - When focus is on an Accordion.Trigger of a collapsed section, expands the section. +- `Tab` - Moves focus to the next focusable element. +- `Shift + Tab` - Moves focus to the previous focusable element. + +### Screen Reader + +- VoiceOver: When the Accordion Item is focused, the screen reader will announce the Accordion's title text and the state of the Accordion trigger (expanded or collapsed). + + +## Examples + +The Examples section provides visual representations of the different variants of the component, allowing you to quickly and easily determine which one best fits your needs. Simply copy the code and integrate it into your project. + +### Customized Component + +The following example demonstrates how easily you can customize the Accordion component to suit your needs. + + + + + + + {({ isExpanded }) => { + return ( + <> + + What does the "type" prop of the Accordion component do? + + {isExpanded ? ( + + ) : ( + + )} + + ); + }} + + + + + The type prop determines whether one or multiple items can be + opened at the same time. The default value is "single" which means + only one item can be opened at a time. + + + + + + + {({ isExpanded }) => { + return ( + <> + + Can I disable the whole accordion? + + {isExpanded ? ( + + ) : ( + + )} + + ); + }} + + + + + Yes, you can disable the whole accordion by setting the isDisabled + prop to true on the Accordion component. + + + + + + + {({ isExpanded }) => { + return ( + <> + + What is a controlled accordion? How can I make it controlled? + + {isExpanded ? ( + + ) : ( + + )} + + ); + }} + + + + + Controlled components refer to the components where the state and behaviors are controlled by the Parent component. You can make the accordion a controlled component by passing the value prop to the Accordion component and setting the onValueChange prop to update the value prop. Refer to the controlled accordion example in the docs. + + + + +); +} +`, +transformCode: (code) => { +return transformedCode(code, 'function', 'App'); +}, +scope: { +Accordion, +AccordionItem, +AccordionHeader, +AccordionTrigger, +AccordionTitleText, +AccordionIcon, +AccordionContent, +AccordionContentText, +ChevronDownIcon, +ChevronUpIcon, +Wrapper, +}, +}} +/> + + + +### Rounded corners + +The borderRadius prop can be used to create rounded corners for both the Accordion and AccordionItem components. + + + + + + + {({ isExpanded }) => { + return ( + <> + {isExpanded ? ( + + ) : ( + + )} + + How do I place an order? + + + ); + }} + + + + + To place an order, simply select the products you want, proceed to + checkout, provide shipping and payment information, and finalize + your purchase. + + + + + + + {({ isExpanded }) => { + return ( + <> + {isExpanded ? ( + + ) : ( + + )} + + What payment methods do you accept? + + + ); + }} + + + + + We accept all major credit cards, including Visa, Mastercard, and + American Express. We also support payments through PayPal. + + + + +); +} +`, + transformCode: (code) => { + return transformedCode(code, 'function', 'App'); + }, + scope: { + Accordion, + AccordionItem, + AccordionHeader, + AccordionTrigger, + AccordionTitleText, + AccordionIcon, + AccordionContent, + AccordionContentText, + MinusIcon, + PlusIcon, + Wrapper, + }, + }} + /> + + +### Disabled item + +You can disable an item by setting the isDisabled prop to true. This will prevent the user from interacting with the item and its content. You can also disable the whole accordion by setting the isDisabled prop to true on the Accordion component. + + + + + + + {({ isExpanded }) => { + return ( + <> + + Disabled Item + + {isExpanded ? ( + + ) : ( + + )} + + + ); + }} + + + + + This is a Disabled Item. + + + + + + + + {({ isExpanded }) => { + return ( + <> + + Is this accordion accessible? + + {isExpanded ? ( + + ) : ( + + )} + + ); + }} + + + + + Yes, the accordion is accessible. It adheres to the WAI-ARIA design + pattern. You can read more about it in the accessibility section of + the docs. + + + + +); +} +`, + transformCode: (code) => { + return transformedCode(code, 'function', 'App'); + }, + scope: { + Accordion, + AccordionItem, + AccordionHeader, + AccordionTrigger, + AccordionTitleText, + AccordionIcon, + AccordionContent, + AccordionContentText, + Divider, + MinusIcon, + PlusIcon, + Wrapper, + }, + }} + /> + + +### Default value + +Use the defaultValue prop to define the open item by default. + + + + + + + {({ isExpanded }) => { + return ( + <> + + What is the defaultValue prop of the Accordion component? + + {isExpanded ? ( + + ) : ( + + )} + + + ); + }} + + + + + The defaultValue prop of the Accordion component is used to define + the open item by default. It is used when the Accordion component is + uncontrolled. + + + + + + + + {({ isExpanded }) => { + return ( + <> + + How many size variants does the Accordion component have? + + {isExpanded ? ( + + ) : ( + + )} + + ); + }} + + + + + The Accordion component has three size variants - sm, md and lg. + + + + + + + + {({ isExpanded }) => { + return ( + <> + + Can I nest my accordions? + + {isExpanded ? ( + + ) : ( + + )} + + ); + }} + + + + + Yes, you can nest your accordions. Refer to the nested accordion example in the docs. + + + + +); +} +`, + transformCode: (code) => { + return transformedCode(code, 'function', 'App'); + }, + scope: { + Accordion, + AccordionItem, + AccordionHeader, + AccordionTrigger, + AccordionTitleText, + AccordionIcon, + AccordionContent, + AccordionContentText, + Divider, + MinusIcon, + PlusIcon, + Wrapper, + }, + }} + /> + + +### Nested Components + +You can nest Accordion components to create a nested accordion. This is useful when you want to group related content together. In the following example, we have created a nested accordion to group the states of USA by region. + + + + + + + {({isExpanded}) => ( + <> + {isExpanded ? ( + + ) : ( + + )} + USA + + )} + + + + + + + + {({isExpanded}) => ( + <> + {isExpanded ? ( + + ) : ( + + )} + + California + + + )} + + + + + Capital city of California is Sacramento. California has a GDP + of 2.89 trillion dollars and follows Pacific Standard Time + zone. + + + + + + + + + {({isExpanded}) => ( + <> + {isExpanded ? ( + + ) : ( + + )} + Nevada + + )} + + + + + Nevada is located in a mountainous region that includes vast + semiarid grasslands and sandy alkali deserts. It is the most + arid state of the country. + + + + + + + +); +} +`, + transformCode: (code) => { + return transformedCode(code, 'function', 'App'); + }, + scope: { + Accordion, + AccordionItem, + AccordionHeader, + AccordionTrigger, + AccordionTitleText, + AccordionIcon, + AccordionContent, + AccordionContentText, + Divider, + MinusIcon, + PlusIcon, + Wrapper, + }, + }} + /> + + +### Controlled Accordion + +A component is controlled when it's managed by its parent using props. +You can make the Accordion component controlled by passing the value prop to the Accordion and setting the onValueChange to update the value prop. In the following example, we have created a controlled accordion to display the expanded state of the accordion. + + + setSelectedValues(item)} className="m-5 w-[95%]"> + + + + {({ isExpanded }) => { + return ( + <> + + Exploring Nature's Wonders + + {isExpanded ? ( + + ) : ( + + )} + + + ); + }} + + + + + Embark on a journey through the breathtaking landscapes and diverse ecosystems of our planet. From majestic mountains to serene oceans, discover the beauty that nature has to offer. + + + + + + + + {({ isExpanded }) => { + return ( + <> + + The Art of Culinary Delights + + {isExpanded ? ( + + ) : ( + + )} + + ); + }} + + + + + Indulge your senses in a culinary adventure. Uncover the secrets behind delectable dishes, learn about unique flavor profiles, and ignite your passion for cooking. + + + + + + + {({ isExpanded }) => { + return ( + <> + + Mastering the Creative Process + + {isExpanded ? ( + + ) : ( + + )} + + ); + }} + + + + + Immerse yourself in the world of creativity. Unleash your artistic potential, whether it's through writing, painting, or any other form of expression. + + + + +); +} +`, + transformCode: (code) => { + return transformedCode(code, 'function', 'App'); + }, + scope: { + Accordion, + AccordionItem, + AccordionHeader, + AccordionTrigger, + AccordionTitleText, + AccordionIcon, + AccordionContent, + AccordionContentText, + Divider, + MinusIcon, + PlusIcon, + PlusIcon, + Wrapper, + }, + }} + /> + + + + + + + + + + -Coming Soon! \ No newline at end of file diff --git a/example/storybook-nativewind/src/core-components/nativewind/accordion/index.tsx b/example/storybook-nativewind/src/core-components/nativewind/accordion/index.tsx index 80ae389e8e..4c06c6f1cb 100644 --- a/example/storybook-nativewind/src/core-components/nativewind/accordion/index.tsx +++ b/example/storybook-nativewind/src/core-components/nativewind/accordion/index.tsx @@ -35,7 +35,7 @@ const accordionTitleTextStyle = tva({ parentVariants: { size: { sm: 'text-sm', - md: 'text-md', + md: 'text-base', lg: 'text-lg', }, }, @@ -48,7 +48,7 @@ const accordionContentTextStyle = tva({ parentVariants: { size: { sm: 'text-sm ', - md: 'text-md', + md: 'text-base', lg: 'text-lg', }, }, @@ -68,8 +68,8 @@ const UIAccordion = createAccordion({ //@ts-ignore Root: Platform.OS === 'web' - ? withStyleContext(Pressable) - : withStyleContextAndStates(Pressable), + ? withStyleContext(View) + : withStyleContextAndStates(View), Item: View, // @ts-ignore Header: Platform.OS === 'web' ? H3 : View,