Skip to content

Commit

Permalink
WIP README
Browse files Browse the repository at this point in the history
  • Loading branch information
ciampo committed Feb 11, 2022
1 parent 99b84de commit f3333b7
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions packages/components/src/number-control/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,58 +27,60 @@ const Example = () => {

## Props

TODO: Should point at `InputControl` for overlapping props

### dragDirection

Determines the drag axis to increment/decrement the value.
Directions: `n` | `e` | `s` | `w`

- Type: `String`
- Type: `n` | `e` | `s` | `w`
- Required: No
- Default: `n`

### dragThreshold

If `isDragEnabled` is true, this controls the amount of `px` to have been dragged before the value changes.
If `isDragEnabled` is `true`, this controls the amount of `px` to have been dragged before the value changes.

- Type: `Number`
- Required: No
- Default: `10`

### hideHTMLArrows

If true, the default `input` HTML arrows will be hidden.
If `true`, the default `input` HTML arrows will be hidden.

- Type: `Boolean`
- Type: `boolean`
- Required: No
- Default: `false`

### isDragEnabled

If true, enables mouse drag gesture to increment/decrement the number value. Holding `SHIFT` while dragging will increase the value by the `shiftStep`.
If `true`, enables mouse drag gesture to increment/decrement the value. Holding `SHIFT` while dragging will increase the value by the `shiftStep`.

- Type: `Boolean`
- Type: `boolean`
- Required: No
- Default: `true`

### isShiftStepEnabled

If true, pressing `UP` or `DOWN` along with the `SHIFT` key will increment the value by the `shiftStep` value.
If `true`, pressing `UP` or `DOWN` along with the `SHIFT` key will increment the value by the `shiftStep` value.

- Type: `Boolean`
- Type: `boolean`
- Required: No
- Default: `true`

### label

If this property is added, a label will be generated using label property as the content.
The text content of the label. If not specified, a label won't be displayed.

- Type: `String`
- Type: `string` // It's actually a React.Node
- Required: No

### labelPosition

The position of the label (`top`, `side`, `bottom`, or `edge`).
The position of the label.

- Type: `String`
- Type: `top` | `side` | `bottom` | `edge`
- Required: No

### max
Expand Down

0 comments on commit f3333b7

Please sign in to comment.