# UX4G Design System

> Government-grade UI foundations for trusted public digital experiences.
> Version: 3.0.18 | Documentation: https://doc.ux4g.gov.in/web/?path=/story/getting-started-introduction--overview

## Overview

UX4G gives product, design, and engineering teams one coherent system for building accessible, consistent, and scalable citizen-facing services. It includes design tokens, CSS utilities, 50+ production-ready components, and reusable patterns for common government workflows.

## Quick links

- Interactive Storybook: https://doc.ux4g.gov.in/web/?path=/story/getting-started-introduction--overview
- Quick Start Guide: https://doc.ux4g.gov.in/web/?path=/story/getting-started-quick-start-guide--docs
- System guide: https://doc.ux4g.gov.in/web/llms-full.txt
- Component catalog (JSON): https://doc.ux4g.gov.in/web/catalog.json
- Agent instructions: https://doc.ux4g.gov.in/web/ai.txt
- Build prompt for LLMs: https://doc.ux4g.gov.in/web/ux4g-prompt.md
- Sitemap: https://doc.ux4g.gov.in/web/sitemap.xml

## Chunked documentation (recommended for LLMs)

Instead of loading one huge file, fetch only the relevant section:

- Getting Started: https://doc.ux4g.gov.in/web/llms/getting-started.md
- Tokens: https://doc.ux4g.gov.in/web/llms/tokens.md
- Token families: https://doc.ux4g.gov.in/web/llms/tokens/
- Utilities: https://doc.ux4g.gov.in/web/llms/utilities.md
- Utility families: https://doc.ux4g.gov.in/web/llms/utilities/
- Layout: https://doc.ux4g.gov.in/web/llms/layout.md
- Components index: https://doc.ux4g.gov.in/web/llms/components.md
- Patterns index: https://doc.ux4g.gov.in/web/llms/patterns.md
- Example pages: https://doc.ux4g.gov.in/web/llms/examples/

## Documentation categories

### Getting Started
- Category guide: https://doc.ux4g.gov.in/web/llms/getting-started.md
- Introduction: https://doc.ux4g.gov.in/web/llms/getting-started/introduction.md
- Quick Start Guide: https://doc.ux4g.gov.in/web/llms/getting-started/quick-start-guide.md

### Tokens
- Category guide: https://doc.ux4g.gov.in/web/llms/tokens.md
- Tokens: https://doc.ux4g.gov.in/web/llms/tokens/tokens.md

### Utilities
- Category guide: https://doc.ux4g.gov.in/web/llms/utilities.md
- Backgrounds: https://doc.ux4g.gov.in/web/llms/utilities/backgrounds.md
- Blur: https://doc.ux4g.gov.in/web/llms/utilities/blur.md
- Borders: https://doc.ux4g.gov.in/web/llms/utilities/borders.md
- Breakpoints: https://doc.ux4g.gov.in/web/llms/utilities/breakpoints.md
- Display: https://doc.ux4g.gov.in/web/llms/utilities/display.md
- Flex: https://doc.ux4g.gov.in/web/llms/utilities/flex.md
- Gap: https://doc.ux4g.gov.in/web/llms/utilities/gap.md
- Interactions: https://doc.ux4g.gov.in/web/llms/utilities/interactions.md
- Margin: https://doc.ux4g.gov.in/web/llms/utilities/margin.md
- Object Fit: https://doc.ux4g.gov.in/web/llms/utilities/object-fit.md
- … and 12 more. See https://doc.ux4g.gov.in/web/llms/utilities.md and catalog.json.

### Layout
- Category guide: https://doc.ux4g.gov.in/web/llms/layout.md
- Container: https://doc.ux4g.gov.in/web/llms/layout/container.md
- Grid System: https://doc.ux4g.gov.in/web/llms/layout/grid-system.md
- Layout-Flex-Grid System: https://doc.ux4g.gov.in/web/llms/layout/layout-flex-grid-system.md

### Components
- Category guide: https://doc.ux4g.gov.in/web/llms/components.md
- Accessibility Bar: https://doc.ux4g.gov.in/web/llms/components/accessibility-bar.md
- Accordion: https://doc.ux4g.gov.in/web/llms/components/accordion.md
- Alert: https://doc.ux4g.gov.in/web/llms/components/alert.md
- Avatar: https://doc.ux4g.gov.in/web/llms/components/avatar.md
- Badge: https://doc.ux4g.gov.in/web/llms/components/badge.md
- Breadcrumb: https://doc.ux4g.gov.in/web/llms/components/breadcrumb.md
- Buttons: https://doc.ux4g.gov.in/web/llms/components/buttons.md
- Card: https://doc.ux4g.gov.in/web/llms/components/card.md
- Carousel: https://doc.ux4g.gov.in/web/llms/components/carousel.md
- Checkbox: https://doc.ux4g.gov.in/web/llms/components/checkbox.md
- … and 42 more. See https://doc.ux4g.gov.in/web/llms/components.md and catalog.json.

### Patterns
- Category guide: https://doc.ux4g.gov.in/web/llms/patterns.md
- Application & Submission / Submission Acknowledgement: https://doc.ux4g.gov.in/web/llms/patterns/application-submission-submission-acknowledgement.md
- Application & Submission / Check Eligibility: https://doc.ux4g.gov.in/web/llms/patterns/application-submission-check-eligibility.md
- Application & Submission / Document Upload: https://doc.ux4g.gov.in/web/llms/patterns/application-submission-document-upload.md
- Application & Submission / Government Form: https://doc.ux4g.gov.in/web/llms/patterns/application-submission-government-form.md
- Application & Submission / Journey Progress: https://doc.ux4g.gov.in/web/llms/patterns/application-submission-journey-progress.md
- Application & Submission / Save & Resume: https://doc.ux4g.gov.in/web/llms/patterns/application-submission-save-resume.md
- Consent & Declaration / Consent History: https://doc.ux4g.gov.in/web/llms/patterns/consent-declaration-consent-history.md
- Consent & Declaration / Consent Required: https://doc.ux4g.gov.in/web/llms/patterns/consent-declaration-consent-required.md
- Consent & Declaration / Withdraw Consent: https://doc.ux4g.gov.in/web/llms/patterns/consent-declaration-withdraw-consent.md
- Dashboard & My Applications / Batch Actions: https://doc.ux4g.gov.in/web/llms/patterns/dashboard-my-applications-batch-actions.md
- … and 47 more. See https://doc.ux4g.gov.in/web/llms/patterns.md and catalog.json.

## How to use this documentation with an LLM

1. Read `llms.txt` for the route map.
2. Read `catalog.json` to find exact components, patterns, or utilities by keyword.
3. Fetch the specific `.md` file for the item you need (e.g., `llms/components/button.md`).
4. For end-to-end page examples, use `llms/examples/`.
5. For agent rules, read `ai.txt`.
6. For a copy-paste system prompt that asks BRD questions before coding, use `ux4g-prompt.md`.

## Model-specific rules

- NEVER send screenshots/images to the `glm-5.2:cloud` model — it does not support images; extract text/data first.