Skip to content

Commit

Permalink
feat: add jsdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
saurabhdaware committed Apr 14, 2023
1 parent d8d19ec commit 239691a
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions packages/blade/src/components/Input/TextInput/TextInput.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,14 @@ type TextInputProps = Pick<
/**
* Type of Input Field to be rendered. Use `PasswordInput` for type `password`
*
*
* **Note on number type**
*
* `type="number"` internally uses `inputMode="numeric"` instead of HTML's `type="number"` which also allows text characters.
* If you have a usecase where you only want to support number input, you can handle it on validations end.
*
* Check out [Why the GOV.UK Design System team changed the input type for numbers](https://technology.blog.gov.uk/2020/02/24/why-the-gov-uk-design-system-team-changed-the-input-type-for-numbers/) for reasoning
*
* @default text
*/
type?: Type;
Expand Down

0 comments on commit 239691a

Please sign in to comment.