Disclosure

Disclosure is an optionally controlled component used to put long sections of information under content blocks that users can expand or collapse by pressing an activator. The activator can be specified as children using an action component (`Button`, `Link` or `Pressable`) or `Checkbox` component. The content blocks can be specified as children inside a structure component (`View`, `InlineLayout`, `BlockStack`, `Grid`, etc.). The library takes care of applying the WAI-ARIA Accordion pattern automatically for the activator and the toggled content.

import {
  render,
  Disclosure,
  Button,
  View,
} from '@shopify/checkout-ui-extensions-react';

render('Checkout::Dynamic::Render', () => );

function Extension() {
  return (
    
      Toggle
      Content
    
  );
}

import {
  extend,
  Button,
  View,
  Disclosure,
} from '@shopify/checkout-ui-extensions';

extend('Checkout::Dynamic::Render', (root) => {
  const disclosure = root.createComponent(Disclosure, {}, [
    root.createComponent(Button, {toggles: 'one'}, 'Toggle'),
    root.createComponent(
      View,
      {border: 'base', padding: 'base', id: 'one'},
      'Content',
    ),
  ]);

  root.appendChild(disclosure);
});

DisclosureProps

DisclosureProps

defaultOpen

For uncontrolled disclosure components, the default `open` state on the initial render. It's possible to specify a boolean value, a string value, or an array of string values: - `true` will expand all content - `false` will collapse all content - `string` will expand the content with the matching `id` - `string[]` will expand the content with the matching `id`s

open

For controlled disclosure components, the open state. The `open` prop should be used along with `onToggle` to create a controlled disclosure component.

onToggle

Callback fired when the open state of the disclosure changes.

transition

Set to 'none' to disable the default transition animation.

MaybeResponsiveConditionalStyle

A type that represents a value that can be a conditional style. The conditions are based on the viewport size. We highly recommend using the `Style` helper which simplifies the creation of conditional styles. To learn more check out the [conditional styles](/api/checkout-ui-extensions/components/utilities/stylehelper) documentation.

T | ConditionalStyle<T, ViewportSizeCondition>

ConditionalStyle

default

The default value applied when none of the conditional values specified in `conditionals` are met.

conditionals

An array of conditional values.

ConditionalValue

conditions

The conditions that must be met for the value to be applied. At least one condition must be specified.

value

The value that will be applied if the conditions are met.

ViewportSizeCondition

viewportInlineSize

ViewportInlineSize

'small' | 'medium' | 'large'

DisclosureOpen

boolean | string | string[]

Examples

Disclosure is an optionally controlled component used to put long sections of information under content blocks that users can expand or collapse by pressing an activator. The activator can be specified as children using an action component (`Button`, `Link` or `Pressable`) or `Checkbox` component. The content blocks can be specified as children inside a structure component (`View`, `InlineLayout`, `BlockStack`, `Grid`, etc.). The library takes care of applying the WAI-ARIA Accordion pattern automatically for the activator and the toggled content.

Use the Disclosure component to simplify the user experience and reveal interfaces only when the customer requests it. It also demonstrates how a combination of inline and block layout components can improve the readability of information. By employing these strategies, users can easily scan and comprehend the content, making for a better user experience overall.

import React from 'react';
import {
  render,
  View,
  Image,
  Icon,
  Pressable,
  Disclosure,
  InlineLayout,
  BlockStack,
  Text,
  Form,
  TextField,
  Button,
  Divider,
  InlineStack,
} from '@shopify/checkout-ui-extensions-react';

render('Checkout::Dynamic::Render', () => (
  
));

export const DisclosureAndAlignment = () => {
  const openIds = ['one'];
  return (
    
      
        
            console.log('onToggle event', open)
          }
        >
          
            
              
              Gift message
              
            
          
          
            

                console.log('onSubmit event')
              }
            >
              
                
                  
                  
                
                
                
                  
                    Save
                  
                
              
            
          
        
        
        
          
          
            
              Verify with
              
            
            
              15% savings for students and
              military
            
          
          
            
          
        
      
    
  );
};

import {
  extend,
  BlockStack,
  View,
  InlineLayout,
  InlineStack,
  Image,
  Pressable,
  Icon,
  Text,
  TextField,
  Form,
  Button,
  Disclosure,
  Divider,
} from '@shopify/checkout-ui-extensions';

extend('Checkout::Dynamic::Render', (root) => {
  const openIds = ['one'];

  const pressable = root.createComponent(
    Pressable,
    {
      toggles: 'one',
      padding: 'base',
    },
    [
      root.createComponent(
        InlineLayout,
        {
          blockAlignment: 'center',
          spacing: 'base',
          columns: ['auto', 'fill', 'auto'],
        },
        [
          root.createComponent(Icon, {
            source: 'gift',
            appearance: 'subdued',
          }),
          'Gift message',
          root.createComponent(Icon, {
            source: openIds.includes('one')
              ? 'chevronUp'
              : 'chevronDown',
            size: 'small',
          }),
        ],
      ),
    ],
  );

  const disclosureView = root.createComponent(
    View,
    {
      id: 'one',
      padding: ['none', 'base', 'base', 'base'],
    },
    [
      root.createComponent(
        Form,
        {
          onSubmit: () =>
            console.log('onSubmit event'),
        },
        [
          root.createComponent(BlockStack, {}, [
            root.createComponent(
              InlineLayout,
              {
                columns: ['fill', 'fill'],
                spacing: 'base',
              },
              [
                root.createComponent(TextField, {
                  label: 'From',
                  name: 'from0',
                  id: 'from0',
                }),
                root.createComponent(TextField, {
                  label: 'To',
                  name: 'to0',
                  id: 'to0',
                }),
              ],
            ),
            root.createComponent(TextField, {
              label: 'Message',
              name: 'message0',
              id: 'message0',
            }),
            root.createComponent(View, {}, [
              root.createComponent(
                Button,
                {
                  accessibilityRole: 'submit',
                  kind: 'secondary',
                },
                'Save',
              ),
            ]),
          ]),
        ],
      ),
    ],
  );

  const disclosure = root.createComponent(
    Disclosure,
    {
      defaultOpen: 'one',
      onToggle: (open) =>
        console.log('onToggle event', open),
    },
    [pressable, disclosureView],
  );

  const inlineLayout = root.createComponent(
    InlineLayout,
    {
      blockAlignment: 'baseline',
      spacing: 'base',
      columns: ['auto', 'fill', 'auto'],
      padding: 'base',
    },
    [
      root.createComponent(Icon, {
        source: 'profile',
        appearance: 'subdued',
      }),
      root.createComponent(
        BlockStack,
        {
          spacing: 'none',
        },
        [
          root.createComponent(
            InlineStack,
            {
              blockAlignment: 'center',
            },
            [
              root.createComponent(
                Text,
                {},
                'Verify with',
              ),
              root.createComponent(Image, {
                source:
                  'https://via.placeholder.com/50x15',
              }),
            ],
          ),
          root.createComponent(
            Text,
            {
              appearance: 'subdued',
              size: 'small',
            },
            '15% savings for students and military',
          ),
        ],
      ),
      root.createComponent(
        Pressable,
        {
          to: 'https://www.shopify.com',
        },
        [
          root.createComponent(Icon, {
            source: 'external',
            appearance: 'subdued',
          }),
        ],
      ),
    ],
  );
  const view = root.createComponent(
    View,
    {
      maxInlineSize: 400,
      cornerRadius: 'large',
      border: 'base',
    },
    [
      root.createComponent(
        BlockStack,
        {
          spacing: 'none',
        },
        [
          disclosure,
          root.createComponent(Divider),
          inlineLayout,
        ],
      ),
    ],
  );

  root.appendChild(view);
});

import React from 'react';
import {
  render,
  View,
  Image,
  Icon,
  Pressable,
  Disclosure,
  InlineLayout,
  BlockStack,
  Text,
  Form,
  TextField,
  Button,
  Divider,
  InlineStack,
} from '@shopify/checkout-ui-extensions-react';

render('Checkout::Dynamic::Render', () => (
  
));

export const DisclosureAndAlignment = () => {
  const openIds = ['one'];
  return (
    
      
        
            console.log('onToggle event', open)
          }
        >
          
            
              
              Gift message
              
            
          
          
            

                console.log('onSubmit event')
              }
            >
              
                
                  
                  
                
                
                
                  
                    Save
                  
                
              
            
          
        
        
        
          
          
            
              Verify with
              
            
            
              15% savings for students and
              military
            
          
          
            
          
        
      
    
  );
};

import {
  extend,
  BlockStack,
  View,
  InlineLayout,
  InlineStack,
  Image,
  Pressable,
  Icon,
  Text,
  TextField,
  Form,
  Button,
  Disclosure,
  Divider,
} from '@shopify/checkout-ui-extensions';

extend('Checkout::Dynamic::Render', (root) => {
  const openIds = ['one'];

  const pressable = root.createComponent(
    Pressable,
    {
      toggles: 'one',
      padding: 'base',
    },
    [
      root.createComponent(
        InlineLayout,
        {
          blockAlignment: 'center',
          spacing: 'base',
          columns: ['auto', 'fill', 'auto'],
        },
        [
          root.createComponent(Icon, {
            source: 'gift',
            appearance: 'subdued',
          }),
          'Gift message',
          root.createComponent(Icon, {
            source: openIds.includes('one')
              ? 'chevronUp'
              : 'chevronDown',
            size: 'small',
          }),
        ],
      ),
    ],
  );

  const disclosureView = root.createComponent(
    View,
    {
      id: 'one',
      padding: ['none', 'base', 'base', 'base'],
    },
    [
      root.createComponent(
        Form,
        {
          onSubmit: () =>
            console.log('onSubmit event'),
        },
        [
          root.createComponent(BlockStack, {}, [
            root.createComponent(
              InlineLayout,
              {
                columns: ['fill', 'fill'],
                spacing: 'base',
              },
              [
                root.createComponent(TextField, {
                  label: 'From',
                  name: 'from0',
                  id: 'from0',
                }),
                root.createComponent(TextField, {
                  label: 'To',
                  name: 'to0',
                  id: 'to0',
                }),
              ],
            ),
            root.createComponent(TextField, {
              label: 'Message',
              name: 'message0',
              id: 'message0',
            }),
            root.createComponent(View, {}, [
              root.createComponent(
                Button,
                {
                  accessibilityRole: 'submit',
                  kind: 'secondary',
                },
                'Save',
              ),
            ]),
          ]),
        ],
      ),
    ],
  );

  const disclosure = root.createComponent(
    Disclosure,
    {
      defaultOpen: 'one',
      onToggle: (open) =>
        console.log('onToggle event', open),
    },
    [pressable, disclosureView],
  );

  const inlineLayout = root.createComponent(
    InlineLayout,
    {
      blockAlignment: 'baseline',
      spacing: 'base',
      columns: ['auto', 'fill', 'auto'],
      padding: 'base',
    },
    [
      root.createComponent(Icon, {
        source: 'profile',
        appearance: 'subdued',
      }),
      root.createComponent(
        BlockStack,
        {
          spacing: 'none',
        },
        [
          root.createComponent(
            InlineStack,
            {
              blockAlignment: 'center',
            },
            [
              root.createComponent(
                Text,
                {},
                'Verify with',
              ),
              root.createComponent(Image, {
                source:
                  'https://via.placeholder.com/50x15',
              }),
            ],
          ),
          root.createComponent(
            Text,
            {
              appearance: 'subdued',
              size: 'small',
            },
            '15% savings for students and military',
          ),
        ],
      ),
      root.createComponent(
        Pressable,
        {
          to: 'https://www.shopify.com',
        },
        [
          root.createComponent(Icon, {
            source: 'external',
            appearance: 'subdued',
          }),
        ],
      ),
    ],
  );
  const view = root.createComponent(
    View,
    {
      maxInlineSize: 400,
      cornerRadius: 'large',
      border: 'base',
    },
    [
      root.createComponent(
        BlockStack,
        {
          spacing: 'none',
        },
        [
          disclosure,
          root.createComponent(Divider),
          inlineLayout,
        ],
      ),
    ],
  );

  root.appendChild(view);
});