react-native-ui-lib/src/components/numberInput/numberInput.api.json

[](https://stand-with-ukraine.pp.ua)

{
  "name": "NumberInput",
  "category": "form",
  "description": "Number Input to create an input with a formatted number",
  "note": "This requires RN67 to work on Android.",
  "example": "https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/NumberInputScreen.tsx",
  "props": [
    {
      "name": "onChangeNumber",
      "type": "(data: NumberInputData) => void",
      "description": "Callback that is called when the number value has changed.",
      "required": true
    },
    {
      "name": "initialNumber",
      "type": "number",
      "description": "A valid number (in en locale, i.e. only digits and a decimal point)."
    },
    {
      "name": "fractionDigits",
      "type": "number",
      "description": "Number of digits after the decimal point. Must be in the range 0 - 20, inclusive.",
      "default": "2"
    },
    {
      "name": "leadingText",
      "type": "string",
      "description": "A leading text"
    },
    {
      "name": "leadingTextStyle",
      "type": "TextStyle",
      "description": "The style of the leading text"
    },
    {
      "name": "trailingText",
      "type": "string",
      "description": "A trailing text"
    },
    {
      "name": "trailingTextStyle",
      "type": "TextStyle",
      "description": "The style of the trailing text"
    },
    {
      "name": "containerStyle",
      "type": "ViewStyle",
      "description": "Container style of the whole component"
    },
    {
      "name": "contextMenuHidden",
      "type": "boolean",
      "description": "If true, context menu is hidden.",
      "default": true,
      "note": "Requires @react-native-community/clipboard to be installed."
    },
    {
      "name": "textFieldProps",
      "type": "TextFieldProps",
      "description": "Most of TextField's props can be applied, except for ones that are passed directly via named props."
    }
  ],
  "snippet": [
    "<NumberInput initialValue={1506$1} onChange={onChange$2} placeholder={'Price$3'}/>"
  ],
  "docs": {
    "hero": {
      "title": "NumberInput",
      "description": "Number Input to create an input with a formatted number"
    },
    "tabs": [
      {
        "title": "UX Guidelines",
        "sections": [
          {
            "type": "section",
            "content": [
              {
                "value": "https://embed.figma.com/design/Krv1pLl7kq2L52vMRwd498/MADS-Guidelines?node-id=8539-460248&embed-host=share",
                "height": 1600
              }
            ]
          }
        ]
      }
    ]
  }
}