> 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/menu-card.md).

# Menu Card

The Menu Card component serves as a navigational tile, guiding users through various modules, processes, or tasks. Built with accessibility, responsiveness, and clarity in mind, this molecule uses strong visual hierarchy with clear icons, descriptions, and optional labels. It supports interaction cues such as hover states and is optimised for multiple device sizes.

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

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

```
// Sample code

<MenuCard
  description="Use this checklist to supervise the team formation for Registration & Distribution"
  icon="Article"
  menuName="Menu"
  onClick={()=>{}}
  styles={{}}
/>
```

{% endtab %}

{% tab title="Component Flutter" %}

```
// Sample code

MenuCard(
            icon: Icons.home,
            heading: 'Label',
            description: 'Description',
            onTap: () {
              // Handle tap
            },
          ),
```

{% endtab %}

{% tab title="Component Design" %}

{% endtab %}
{% endtabs %}

## Anatomy

<figure><img src="/files/zgGocDiiiJnCXB9hnhU9" 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/EjLuWvaOL2I2ORtsHW4R" alt=""><figcaption></figcaption></figure></div></td><td><p><strong>Menu 1</strong></p><p>A basic card with an icon and a short descriptive text for task or module access.</p></td></tr><tr><td><div><figure><img src="/files/kYtz6zY9q5QQ3Ff6POD9" alt=""><figcaption></figcaption></figure></div></td><td><strong>Menu 2</strong><br>Extends Menu 1 by including a Label next to the icon to add context or categorisation.</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>Icon - Menu 1 &#x26; 2</strong><br>Clearly conveys the function or context of the menu item.<br></td><td><div><figure><img src="/files/2aOsNTvBbBV84NYjkD2P" alt=""><figcaption></figcaption></figure></div></td></tr><tr><td><strong>Description - Menu 1 &#x26; 2</strong><br>A short line of text to inform the user about the menu’s purpose, to indicate that the button is not active.</td><td><div><figure><img src="/files/LchFCQ8EAnKTvDjgmdaq" alt=""><figcaption></figcaption></figure></div></td></tr><tr><td><strong>Label - Menu 2</strong><br>Appears above the description and helps name or categorise grouped items.</td><td><div><figure><img src="/files/bBi4pYAfaDP3H2MVnN4d" 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>icon</td><td>text</td><td>-</td></tr><tr><td>menuName</td><td>text</td><td>-</td></tr><tr><td>description</td><td>yes/no</td><td>no</td></tr><tr><td>className</td><td>yes/no</td><td>no</td></tr><tr><td>styles</td><td>number</td><td>-</td></tr><tr><td>onClick</td><td>yes/no</td><td>-</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>heading</td><td>String</td><td>required</td></tr><tr><td>description</td><td>String</td><td>-</td></tr><tr><td>Icon</td><td>Icon Data</td><td>-</td></tr><tr><td>onTap</td><td>VoidCallBack</td><td>-</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

## Usage Guide

***

| <div><figure><img src="/files/K54Lou6qYGViT1WA4gRZ" alt=""><figcaption></figcaption></figure></div> | <p><strong>Maintain clarity</strong></p><p>Use concise, descriptive labels and explanations for each card.  Overload the card with long sentences or technical jargon..</p> |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <div><figure><img src="/files/ptV8n7XHJIx7mKWGYPqp" 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 <a href="#design-checklist" id="design-checklist"></a>

<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/menu-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.
