Skip to main content

Accordion

Accordion component from Scaffald UI component library.

Import​

import { Accordion } from '@scaffald/ui';

Basic Usage​

Live Preview
<ThemeProvider initialTheme="light">
<Accordion defaultValue="item1">
  <Accordion.Item value="item1">
    <Accordion.Trigger>What is Scaffald UI?</Accordion.Trigger>
    <Accordion.Content>
      <Text>Scaffald UI is a production-ready component library for React Native and Web.</Text>
    </Accordion.Content>
  </Accordion.Item>
  <Accordion.Item value="item2">
    <Accordion.Trigger>How do I install it?</Accordion.Trigger>
    <Accordion.Content>
      <Text>Run npm install @scaffald/ui in your project.</Text>
    </Accordion.Content>
  </Accordion.Item>
  <Accordion.Item value="item3">
    <Accordion.Trigger>Is it cross-platform?</Accordion.Trigger>
    <Accordion.Content>
      <Text>Yes! It works on iOS, Android, and Web.</Text>
    </Accordion.Content>
  </Accordion.Item>
</Accordion>
</ThemeProvider>

Props​

See the TypeScript definitions for the complete props API.

Common Props​

All Accordion components accept standard React Native View props.

Variants​

See component props for available variants.

Examples​

Advanced Usage​

// Example implementation
<Accordion variant="default">
Example content
</Accordion>

Headless Hook (useAccordion)​

For power users who need complete control over the visual presentation but want to leverage the robust state management and accessibility logic of the Accordion, you can use the useAccordion and useAccordionItem headless hooks.

import { useAccordion, useAccordionItem } from '@scaffald/ui';

function CustomAccordion() {
const accordion = useAccordion({ mode: 'multiple' });

return (
<CustomProvider value={accordion}>
<CustomAccordionItem value="1" />
<CustomAccordionItem value="2" />
</CustomProvider>
);
}

Accessibility​

  • Keyboard navigation support
  • Screen reader compatible
  • ARIA attributes included
  • Focus management

Design Tokens​

This component uses the following design tokens:

  • Colors: colors.{semantic}.{theme}.{variant}
  • Spacing: spacing.*
  • Typography: typography.*

See Design Tokens for more information.

No related components.

Changelog​

See GitHub Releases for version history.