> For the complete documentation index, see [llms.txt](https://docs.digit.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digit.org/platform/guides/developer-guide/ui-developer-guide/digit-ui-components0.2.0/molecule/filter-card.md).

# Bottom Sheet

The Bottom Sheet is a flexible, slide-up container designed to provide supplementary content or actions without disrupting the main screen. It supports modular interactions like previews, confirmations, or micro-tasks, enhancing task efficiency and reducing navigational depth.

<figure><img src="/files/F0Ev6RelwY2oamTGc3p4" alt=""><figcaption></figcaption></figure>

{% tabs %}
{% tab title="Component React" %}

```
// Sample code

<BottomSheet
  actions={[
    <Button key="1" label="Cancel" variation="secondary"/>,
    <Button key="2" label="Submit"/>
  ]}
  className=""
  enableActions
  initialState="closed"
  style={{}}
>
  <AlertCard
    label="Info"
    populators={{
      name: 'alertcard'
    }}
    text="Application process will take a minute to complete. It might cost around Rs.500/- to Rs.1000/- to clean your septic tank and you can expect the service to get completed in 24 hrs from the time of payment."
    variant="default"
  />
  <img
    alt="Additional Element 2"
    src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQIGMLufj86aep95KwMzr3U0QShg7oxdAG8gBPJ9ALIFQ&s"
  />
  <AlertCard
    label="Info"
    populators={{
      name: 'alertcard'
    }}
    text="Application process will take a minute to complete. It might cost around Rs.500/- to Rs.1000/- to clean your septic tank and you can expect the service to get completed in 24 hrs from the time of payment."
    variant="default"
  />
</BottomSheet>
```

{% endtab %}

{% tab title="Component Flutter" %}

```
// Sample code

DigitBottomSheet(
          content: const RegistrationForm(),
          fixedHeight: 400,
          primaryActionLabel: 'Submit',
          onPrimaryAction: (context) {
            // Handle registration
          },
          disableDrag: "Disable Drag",
        );
```

{% endtab %}

{% tab title="Component Design" %}

{% endtab %}
{% endtabs %}

## Anatomy

<figure><img src="/files/a3MY1EwmPzyADufv7OJO" alt=""><figcaption></figcaption></figure>

## Variants

***

<table data-header-hidden><thead><tr><th width="321"></th><th></th></tr></thead><tbody><tr><td><div><figure><img src="/files/gh0ApZYvDwXDUojdVSyX" alt=""><figcaption></figcaption></figure></div></td><td><p><strong>Default</strong></p><p>A simple bottom sheet layout with a header, short description, and optional content. Best used for lightweight contextual information.</p></td></tr><tr><td><div><figure><img src="/files/PDtYKEqo5WxfX5r7rcKS" alt=""><figcaption></figcaption></figure></div></td><td><strong>With Actions</strong><br>Includes one or more action buttons at the bottom of the sheet, useful for tasks like confirming selections, saving changes, or proceeding to next steps.</td></tr><tr><td><div><figure><img src="/files/lBwvCEEBGad6yo0ekxxB" alt=""><figcaption></figcaption></figure></div></td><td><p><strong>Custom</strong></p><p>Fully customizable content area with additional elements like images, forms, or dynamic content blocks. Ideal for detailed workflows or input-heavy interactions.</p></td></tr></tbody></table>

## Properties

<table data-header-hidden data-full-width="false"><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><strong>Drag Enabled</strong><br>A draggable indicator allows users to pull the bottom sheet up or down, enabling smooth expand/collapse interactions on touch or mobile interfaces.<br></td><td><div><figure><img src="/files/lFRYgNnjpRzpagL0NCc9" alt=""><figcaption></figcaption></figure></div></td></tr><tr><td><strong>Additional Widgets</strong><br>Supports the inclusion of elements like icons, images, forms, toggles, or dropdowns, depending on context and user need.</td><td><div><figure><img src="/files/Mja3BDdQw2sFpqBQEyIV" alt=""><figcaption></figcaption></figure></div></td></tr><tr><td><p><strong>Custom Height</strong></p><p>Allows for variable height adjustments based on content needs, either fixed height or auto-adjusting to fit dynamic content gracefully.</p></td><td><div><figure><img src="/files/evbor3NVgyGGrkYarD5i" alt=""><figcaption></figcaption></figure></div></td></tr></tbody></table>

## Property Configuration Table

Each design component offers a range of configurable options. These options are intentionally platform-agnostic, allowing implementations to adapt and tailor them to align with the specific requirements of the chosen framework.

{% tabs %}
{% tab title="React" %}

<table><thead><tr><th width="257">Property</th><th>Value</th><th>Default</th></tr></thead><tbody><tr><td>children</td><td>text</td><td>-</td></tr><tr><td>initialState</td><td>text</td><td>-</td></tr><tr><td>enableActions</td><td>yes/no</td><td>no</td></tr><tr><td>actions</td><td>yes/no</td><td>no</td></tr><tr><td>equalWidthButtons</td><td>number</td><td>-</td></tr><tr><td>className</td><td>yes/no</td><td>no</td></tr><tr><td>style</td><td>yes/no</td><td>no</td></tr></tbody></table>
{% endtab %}

{% tab title="Flutter" %}

<table><thead><tr><th>Property</th><th width="209">Value</th><th>Default</th></tr></thead><tbody><tr><td>content</td><td>Widget</td><td>required</td></tr><tr><td>initialHeightPercentage</td><td>double</td><td>-</td></tr><tr><td>fixedHeight</td><td>double</td><td>-</td></tr><tr><td>disableDrag</td><td>bool</td><td>false</td></tr><tr><td>primaryActionLabel</td><td>String</td><td>-</td></tr><tr><td>secondaryActionLabel</td><td>String</td><td>-</td></tr><tr><td>onPrimaryAction</td><td>void Function(BuildContext context)</td><td>false</td></tr><tr><td>onSecondaryAction</td><td>void Function(BuildContext context)</td><td>false</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

## Usage Guide

***

| <div><figure><img src="/files/Qo1JvS5lfC51Cr5YABJg" alt=""><figcaption></figcaption></figure></div> | <p><strong>Use for Mobile-Friendly Overlays</strong></p><p>Use the Bottom Sheet for short interactions like selecting options, viewing summaries, or executing simple actions.  Don’t use it for full-length forms or detailed multi-step tasks—use a full modal or side panel instead.</p> |
| --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <div><figure><img src="/files/s35izEhiwCrdhi16pola" alt=""><figcaption></figcaption></figure></div> |                                                                                                                                                                                                                                                                                             |

## Change log

***

| Date         | Number  | Notes                                                                                           |
| ------------ | ------- | ----------------------------------------------------------------------------------------------- |
| Dec 15, 2024 | v-0.0.2 | <p>This component is added to the website.<br>This component is now individually versioned.</p> |

## Design Checklist

***

<table data-header-hidden><thead><tr><th width="129" data-type="checkbox"></th><th></th></tr></thead><tbody><tr><td>true</td><td><strong>All interactive states</strong> - Includes all interactive states that are applicable (hover, down, focus, keyboard focus, disabled).</td></tr><tr><td>true</td><td><strong>Accessible use of colours</strong> - Colour is not used as the only visual means of conveying information (WCAG 2.1 1.4.1)</td></tr><tr><td>true</td><td><strong>Accessible contrast for text</strong> - Text has a contrast ratio of at least 4.5:1 for small text and at least 3:1 for large text (WCAG 2.0 1.4.3).</td></tr><tr><td>true</td><td><strong>Accessible contrast for UI components</strong> - Visual information required to identify components and states (except inactive components) has a contrast ratio of at least 3:1 (WCAG 2.1 1.4.11).</td></tr><tr><td>true</td><td><strong>Keyboard interactions</strong> - Includes all interactive states that are applicable (hover, down, focus, keyboard focus, disabled).</td></tr><tr><td>false</td><td><strong>Screen reader accessible</strong> - All content, including headings, labels, and descriptions, is meaningful, concise, contextual and accessible by screen readers.</td></tr><tr><td>true</td><td><strong>Responsive for all breakpoints</strong> - Responsiveness for 3 breakpoints - Mobile, Tablet and Desktop</td></tr><tr><td>true</td><td><strong>Usage guidelines</strong> - Includes a list of dos and don'ts that highlight best practices and common mistakes.</td></tr><tr><td>false</td><td><strong>Content guidelines</strong> - Content standards and usage guidelines for writing and formatting in-product content for the component.</td></tr><tr><td>true</td><td><strong>Defined variants and properties</strong> - Includes relevant variants and properties (style, size, orientation, optional iconography, decorative elements, selection states, error states, etc.)</td></tr><tr><td>true</td><td><strong>Defined behaviours</strong> - Guidelines for keyboard navigation and focus, layout management (including wrapping, truncation, and overflow), animations, and user interactions.</td></tr><tr><td>true</td><td><strong>Design Kit</strong> - Access to the design file for the component in Figma, multiple options, states, colour themes, and platform scales.</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.digit.org/platform/guides/developer-guide/ui-developer-guide/digit-ui-components0.2.0/molecule/filter-card.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
