@redsift/ds-mcp-server 12.3.1-muiv6-alpha.2

package/data/docs/components/design-system/Number.json

@@ -0,0 +1,773 @@
+{
+  "name": "Number",
+  "description": "Number formats and displays numeric values with locale-aware formatting.\nSupports decimal, currency, percent, and unit formatting using the\nIntl.NumberFormat API.\n\nVariants: `body`, `button`, `caption`, `inherit` (typography style)\nSemantic elements: `span` (default), `p`, `b`, `i`, `u`, etc. via `as` prop",
+  "package": "@redsift/design-system",
+  "filePath": "packages/design-system/src/components/number/Number.tsx",
+  "props": [
+    {
+      "name": "value",
+      "description": "Value.",
+      "type": "number",
+      "required": true,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "type",
+      "description": "The formatting style to use.",
+      "type": [
+        "\"decimal\"",
+        "\"currency\"",
+        "\"percent\"",
+        "\"unit\""
+      ],
+      "required": false,
+      "defaultValue": "'decimal'",
+      "category": "props"
+    },
+    {
+      "name": "compactDisplay",
+      "description": "Only used when notation is 'compact'.",
+      "type": [
+        "\"short\"",
+        "\"long\""
+      ],
+      "required": false,
+      "defaultValue": "'short'",
+      "category": "props"
+    },
+    {
+      "name": "currency",
+      "description": "The currency to use in currency formatting. Possible values are the ISO 4217 currency codes, such as \"USD\" for the US dollar, \"EUR\" for the euro, or \"CNY\" for the Chinese RMB",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "currencyDisplay",
+      "description": "How to display the currency in currency formatting.",
+      "type": [
+        "\"symbol\"",
+        "\"code\"",
+        "\"narrowSymbol\"",
+        "\"name\""
+      ],
+      "required": false,
+      "defaultValue": "'symbol'",
+      "category": "props"
+    },
+    {
+      "name": "currencySign",
+      "description": "In many locales, accounting format means to wrap the number with parentheses instead of appending a minus sign.",
+      "type": [
+        "\"standard\"",
+        "\"accounting\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "localeMatcher",
+      "description": "The locale matching algorithm to use.",
+      "type": [
+        "\"best fit\"",
+        "\"lookup\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "notation",
+      "description": "The formatting that should be displayed for the number.",
+      "type": [
+        "\"standard\"",
+        "\"scientific\"",
+        "\"engineering\"",
+        "\"compact\""
+      ],
+      "required": false,
+      "defaultValue": "'short'",
+      "category": "props"
+    },
+    {
+      "name": "numberingSystem",
+      "description": "Overrides default numbering system for the current locale.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "signDisplay",
+      "description": "When to display the sign for the number.",
+      "type": [
+        "\"auto\"",
+        "\"always\"",
+        "\"exceptZero\"",
+        "\"never\""
+      ],
+      "required": false,
+      "defaultValue": "'auto'",
+      "category": "props"
+    },
+    {
+      "name": "unit",
+      "description": "The unit to use in unit formatting.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "unitDisplay",
+      "description": "The unit formatting style to use in unit formatting.",
+      "type": [
+        "\"short\"",
+        "\"long\"",
+        "\"narrow\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "useGrouping",
+      "description": "Whether to use grouping separators.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "roundingMode",
+      "description": "Options for rounding modes.",
+      "type": [
+        "\"ceil\"",
+        "\"floor\"",
+        "\"expand\"",
+        "\"trunc\"",
+        "\"halfCeil\"",
+        "\"halfFloor\"",
+        "\"halfExpand\"",
+        "\"halfTrunc\"",
+        "\"halfEven\""
+      ],
+      "required": false,
+      "defaultValue": "'halfExpand'",
+      "category": "props"
+    },
+    {
+      "name": "roundingPriority",
+      "description": "Specify how rounding conflicts will be resolved.",
+      "type": [
+        "\"auto\"",
+        "\"morePrecision\"",
+        "\"lessPrecision\""
+      ],
+      "required": false,
+      "defaultValue": "'auto'",
+      "category": "props"
+    },
+    {
+      "name": "roundingIncrement",
+      "description": "Specifies the rounding-increment precision.",
+      "type": [
+        "1",
+        "2",
+        "5",
+        "10",
+        "20",
+        "25",
+        "50",
+        "100",
+        "200",
+        "250",
+        "500",
+        "1000",
+        "2000",
+        "2500",
+        "5000"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "trailingZeroDisplay",
+      "description": "A string expressing the strategy for displaying trailing zeros on whole numbers.",
+      "type": [
+        "\"auto\"",
+        "\"stripIfInteger\""
+      ],
+      "required": false,
+      "defaultValue": "'auto'",
+      "category": "props"
+    },
+    {
+      "name": "minimumIntegerDigits",
+      "description": "The minimum number of integer digits to use. A value with a smaller number of integer digits than this number will be left-padded with zeros (to the specified length) when formatted.",
+      "type": [
+        "1",
+        "2",
+        "5",
+        "10",
+        "20",
+        "3",
+        "4",
+        "6",
+        "7",
+        "8",
+        "9",
+        "11",
+        "12",
+        "13",
+        "14",
+        "15",
+        "16",
+        "17",
+        "18",
+        "19",
+        "21"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "minimumFractionDigits",
+      "description": "The minimum number of fraction digits to use.",
+      "type": [
+        "0",
+        "1",
+        "2",
+        "5",
+        "10",
+        "20",
+        "3",
+        "4",
+        "6",
+        "7",
+        "8",
+        "9",
+        "11",
+        "12",
+        "13",
+        "14",
+        "15",
+        "16",
+        "17",
+        "18",
+        "19"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "maximumFractionDigits",
+      "description": "The maximum number of fraction digits to use.",
+      "type": [
+        "0",
+        "1",
+        "2",
+        "5",
+        "10",
+        "20",
+        "3",
+        "4",
+        "6",
+        "7",
+        "8",
+        "9",
+        "11",
+        "12",
+        "13",
+        "14",
+        "15",
+        "16",
+        "17",
+        "18",
+        "19"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "minimumSignificantDigits",
+      "description": "The minimum number of significant digits to use.",
+      "type": [
+        "1",
+        "2",
+        "5",
+        "10",
+        "20",
+        "3",
+        "4",
+        "6",
+        "7",
+        "8",
+        "9",
+        "11",
+        "12",
+        "13",
+        "14",
+        "15",
+        "16",
+        "17",
+        "18",
+        "19",
+        "21"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "maximumSignificantDigits",
+      "description": "The maximum number of significant digits to use.",
+      "type": [
+        "1",
+        "2",
+        "5",
+        "10",
+        "20",
+        "3",
+        "4",
+        "6",
+        "7",
+        "8",
+        "9",
+        "11",
+        "12",
+        "13",
+        "14",
+        "15",
+        "16",
+        "17",
+        "18",
+        "19",
+        "21"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "as",
+      "description": "Override component.",
+      "type": [
+        "\"abbr\"",
+        "\"b\"",
+        "\"cite\"",
+        "\"del\"",
+        "\"em\"",
+        "\"i\"",
+        "\"ins\"",
+        "\"kbd\"",
+        "\"mark\"",
+        "\"p\"",
+        "\"s\"",
+        "\"samp\"",
+        "\"sub\"",
+        "\"sup\"",
+        "\"u\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "color",
+      "description": "Color variant. Either from color palette or hex or rgb strings.",
+      "type": [
+        "\"primary\"",
+        "\"secondary\"",
+        "\"error\"",
+        "\"success\"",
+        "\"warning\"",
+        "\"info\"",
+        "\"question\"",
+        "\"no-data\"",
+        "\"black\"",
+        "\"x-dark-grey\"",
+        "\"dark-grey\"",
+        "\"mid-grey\"",
+        "\"light-grey\"",
+        "\"x-light-grey\"",
+        "\"white\"",
+        "\"radar\"",
+        "string & {}"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "fontFamily",
+      "description": "Font family.",
+      "type": [
+        "\"poppins\"",
+        "\"source-code-pro\"",
+        "\"inconsolata\""
+      ],
+      "required": false,
+      "defaultValue": "'poppins'",
+      "category": "props"
+    },
+    {
+      "name": "fontSize",
+      "description": "Font size.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "fontWeight",
+      "description": "Font weight.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "lineHeight",
+      "description": "Line height.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "noWrap",
+      "description": "Whether the text will truncate with a text overflow ellipsis or wrap.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "theme",
+      "description": "Theme.",
+      "type": [
+        "\"light\"",
+        "\"dark\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "variant",
+      "description": "Variant.",
+      "type": [
+        "\"body\"",
+        "\"button\"",
+        "\"caption\"",
+        "\"helper\"",
+        "\"inherit\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "wordBreak",
+      "description": "Word break CSS properties",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "highlightNonAscii",
+      "description": "Highlight non-ASCII characters. Useful for IDN domain names where\nUnicode lookalike characters can be confusing.\n\n- `true`: enables both font change and background highlight\n- `{ font?: boolean, background?: boolean | string }`: fine-grained control\n\nOnly works with string children.\n@example // Both font and background (default)\n<Text highlightNonAscii>ƅankofamerica.com</Text>\n@example // Background only\n<Text highlightNonAscii={{ font: false }}>ƅankofamerica.com</Text>\n@example // Font only\n<Text highlightNonAscii={{ background: false }}>ƅankofamerica.com</Text>\n@example // Custom background color\n<Text highlightNonAscii={{ background: 'error' }}>ƅankofamerica.com</Text>",
+      "type": [
+        "false",
+        "true",
+        "HighlightNonAsciiOptions"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "flex",
+      "description": "When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/flex\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "flexGrow",
+      "description": "When used in a flex layout, specifies how the element will grow to fit the space available. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/flex-grow\">MDN</a>.",
+      "type": "number",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "flexShrink",
+      "description": "When used in a flex layout, specifies how the element will shrink to fit the space available. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/flex-shrink\">MDN</a>.",
+      "type": "number",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "flexBasis",
+      "description": "When used in a flex layout, specifies the initial main size of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/flex_basis\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "alignSelf",
+      "description": "Overrides the alignItems property of a flex or grid container. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/align-self\">MDN</a>.",
+      "type": [
+        "\"center\"",
+        "\"auto\"",
+        "\"normal\"",
+        "\"start\"",
+        "\"end\"",
+        "\"flex-start\"",
+        "\"flex-end\"",
+        "\"self-start\"",
+        "\"self-end\"",
+        "\"baseline\"",
+        "\"stretch\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "justifySelf",
+      "description": "Specifies how the element is justified inside a flex or grid container. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/justify-self\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "order",
+      "description": "The layout order for the element within a flex or grid container. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/order\">MDN</a>.",
+      "type": "number",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "gridArea",
+      "description": "When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/grid-area\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "gridColumn",
+      "description": "When used in a grid layout, specifies the column the element should be placed in within the grid. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "gridRow",
+      "description": "When used in a grid layout, specifies the row the element should be placed in within the grid. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "gridColumnStart",
+      "description": "When used in a grid layout, specifies the starting column to span within the grid. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column-start\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "gridColumnEnd",
+      "description": "When used in a grid layout, specifies the ending column to span within the grid. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column-end\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "gridRowStart",
+      "description": "When used in a grid layout, specifies the starting row to span within the grid. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row-start\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "gridRowEnd",
+      "description": "When used in a grid layout, specifies the ending row to span within the grid. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row-end\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "margin",
+      "description": "The margin for all four sides of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/margin\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "spacing"
+    },
+    {
+      "name": "marginBottom",
+      "description": "The margin for the bottom side of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/margin-bottom\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "spacing"
+    },
+    {
+      "name": "marginLeft",
+      "description": "The margin for the left side of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/margin-left\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "spacing"
+    },
+    {
+      "name": "marginRight",
+      "description": "The margin for the right side of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/margin-right\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "spacing"
+    },
+    {
+      "name": "marginTop",
+      "description": "The margin for the top side of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/margin-top\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "spacing"
+    },
+    {
+      "name": "height",
+      "description": "The height of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/height\">MDN</a>.",
+      "type": [
+        "string",
+        "number"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "sizing"
+    },
+    {
+      "name": "maxHeight",
+      "description": "The maximum height of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/max-height\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "sizing"
+    },
+    {
+      "name": "maxWidth",
+      "description": "The maximum width of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/max-width\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "sizing"
+    },
+    {
+      "name": "minHeight",
+      "description": "The minimum height of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/min-height\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "sizing"
+    },
+    {
+      "name": "minWidth",
+      "description": "The minimum width of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/min-width\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "sizing"
+    },
+    {
+      "name": "width",
+      "description": "The width of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/width\">MDN</a>.",
+      "type": [
+        "string",
+        "number"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "sizing"
+    },
+    {
+      "name": "position",
+      "description": "Specifies how the element is positioned. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/position\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "positioning"
+    },
+    {
+      "name": "top",
+      "description": "The top position for the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/top\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "positioning"
+    },
+    {
+      "name": "bottom",
+      "description": "The bottom position for the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/bottom\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "positioning"
+    },
+    {
+      "name": "left",
+      "description": "The left position for the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/left\">MDN</a>. Consider using start instead for RTL support.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "positioning"
+    },
+    {
+      "name": "right",
+      "description": "The right position for the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/right\">MDN</a>. Consider using start instead for RTL support.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "positioning"
+    },
+    {
+      "name": "zIndex",
+      "description": "The stacking order for the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/z-index\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "positioning"
+    }
+  ],
+  "examples": [],
+  "tags": {}
+}