Skip to content

Commit

Permalink
Components: Add 40px size prop to readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
mirka committed Aug 16, 2024
1 parent 8169dfd commit b0f7524
Show file tree
Hide file tree
Showing 18 changed files with 134 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -169,3 +169,10 @@ const splitBorders = {
```

- Required: No

### `__next40pxDefaultSize`: `boolean`

Start opting into the larger default height that will become the default size in a future version.

- Required: No
- Default: `false`
Original file line number Diff line number Diff line change
Expand Up @@ -173,3 +173,10 @@ Flags whether this `BorderControl` should also render a `RangeControl` for
additional control over a border's width.

- Required: No

### `__next40pxDefaultSize`: `boolean`

Start opting into the larger default height that will become the default size in a future version.

- Required: No
- Default: `false`
7 changes: 7 additions & 0 deletions packages/components/src/button/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,13 @@ Specifies the button's style. The accepted values are `'primary'` (the primary b

- Required: No

#### `__next40pxDefaultSize`: `boolean`

Start opting into the larger default height that will become the default size in a future version.

- Required: No
- Default: `false`

## Related components

- To group buttons together, use the [ButtonGroup](/packages/components/src/button-group/README.md) component.
8 changes: 8 additions & 0 deletions packages/components/src/combobox-control/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,14 @@ Custom renderer invoked for each option in the suggestion list. The render prop
- Type: `( args: { item: object } ) => ReactNode`
- Required: No

#### __next40pxDefaultSize

Start opting into the larger default height that will become the default size in a future version.

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

#### __nextHasNoMarginBottom

Start opting into the new margin-free styles that will become the default in a future version.
Expand Down
7 changes: 7 additions & 0 deletions packages/components/src/custom-select-control/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,13 @@ A handler for `blur` events on the trigger button.

- Required: No

#### `__next40pxDefaultSize`: `boolean`

Start opting into the larger default height that will become the default size in a future version.

- Required: No
- Default: `false`

## Related components

- Like this component, but implemented using a native `<select>` for when custom styling is not necessary, the `SelectControl` component.
Expand Down
18 changes: 13 additions & 5 deletions packages/components/src/dimension-control/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,10 +93,18 @@ A callback which is triggered when a spacing size value changes (is selected/cli

A string of classes to be added to the control component.

### __nextHasNoMarginBottom
### `__next40pxDefaultSize`

Start opting into the new margin-free styles that will become the default in a future version.
- **Type:** `Boolean`
- **Required:** No
- **Default:** `false`

Start opting into the larger default height that will become the default size in a future version.

### `__nextHasNoMarginBottom`

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

Start opting into the new margin-free styles that will become the default in a future version.
10 changes: 9 additions & 1 deletion packages/components/src/focal-point-picker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,10 +100,18 @@ Callback which is called at the start of drag operations.

Function which is called before internal updates to the value state. It receives the upcoming value and may return a modified one.

#### __nextHasNoMarginBottom
### `__next40pxDefaultSize`

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

Start opting into the new margin-free styles that will become the default in a future version.

#### `__nextHasNoMarginBottom`

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

Start opting into the new margin-free styles that will become the default in a future version.
7 changes: 7 additions & 0 deletions packages/components/src/font-size-picker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,3 +113,10 @@ If `true`, a slider will be displayed alongside the input field when a custom fo

- Required: no
- Default: `false`

### `__next40pxDefaultSize`: `boolean`

Start opting into the larger default height that will become the default size in a future version.

- Required: No
- Default: `false`
8 changes: 8 additions & 0 deletions packages/components/src/form-file-upload/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,3 +85,11 @@ Optional callback function used to render the UI. If passed, the component does

- Type: `Function`
- Required: No

### __next40pxDefaultSize

Start opting into the larger default height that will become the default size in a future version.

- Type: `Boolean`
- Required: No
- Default: `false`
1 change: 1 addition & 0 deletions packages/components/src/form-token-field/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ The `value` property is handled in a manner similar to controlled form component
- `__experimentalShowHowTo` - If false, the text on how to use the select (ie: _Separate with commas or the Enter key._) will be hidden.
- `__experimentalValidateInput` - If passed, all introduced values will be validated before being added as tokens.
- `__experimentalAutoSelectFirstMatch` - If true, the select the first matching suggestion when the user presses the Enter key (or space when tokenizeOnSpace is true).
- `__next40pxDefaultSize` - Start opting into the larger default height that will become the default size in a future version.
- `__nextHasNoMarginBottom` - Start opting into the new margin-free styles that will become the default in a future version, currently scheduled to be WordPress 7.0. (The prop can be safely removed once this happens.)
- `tokenizeOnBlur` - If true, add any incompleteTokenValue as a new token when the field loses focus.

Expand Down
8 changes: 8 additions & 0 deletions packages/components/src/input-control/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,3 +107,11 @@ The current value of the input.
- Type: `String`
- Required: No
### __next40pxDefaultSize
Start opting into the larger default height that will become the default size in a future version.
- Type: `Boolean`
- Required: No
- Default: `false`
8 changes: 8 additions & 0 deletions packages/components/src/number-control/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,3 +139,11 @@ Amount by which the `value` is changed when incrementing/decrementing. It is als
- Type: `Number | "any"`
- Required: No
- Default: `1`

### __next40pxDefaultSize

Start opting into the larger default height that will become the default size in a future version.

- Type: `Boolean`
- Required: No
- Default: `false`
7 changes: 7 additions & 0 deletions packages/components/src/query-controls/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -240,3 +240,10 @@ The selected category for the `categoriesList` prop.

- Required: No
- Platform: Web

#### `__next40pxDefaultSize`: `boolean`

Start opting into the larger default height that will become the default size in a future version.

- Required: No
- Default: `false`
7 changes: 7 additions & 0 deletions packages/components/src/range-control/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,13 @@ Determines if the `input` number field will render next to the RangeControl. Thi
- Required: No
- Platform: Web

### `__next40pxDefaultSize`: `boolean`

Start opting into the larger default height that will become the default size in a future version.

- Required: No
- Default: `false`

### `__nextHasNoMarginBottom`: `boolean`

Start opting into the new margin-free styles that will become the default in a future version.
Expand Down
8 changes: 8 additions & 0 deletions packages/components/src/select-control/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,14 @@ The style variant of the control.
- Required: No
- Default: `'default'`

### __next40pxDefaultSize

Start opting into the larger default height that will become the default size in a future version.

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

### __nextHasNoMarginBottom

Start opting into the new margin-free styles that will become the default in a future version.
Expand Down
8 changes: 8 additions & 0 deletions packages/components/src/text-control/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,14 @@ A function that receives the value of the input.
- Type: `function`
- Required: Yes

#### __next40pxDefaultSize

Start opting into the larger default height that will become the default size in a future version.

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

## Related components

- To offer users more constrained options for input, use SelectControl, RadioControl, CheckboxControl, or RangeControl.
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,13 @@ The value of the `ToggleGroupControl`.

- Required: No

### `__next40pxDefaultSize`: `boolean`

Start opting into the larger default height that will become the default size in a future version.

- Required: No
- Default: `false`

### `__nextHasNoMarginBottom`: `boolean`

Start opting into the new margin-free styles that will become the default in a future version.
Expand Down
7 changes: 7 additions & 0 deletions packages/components/src/unit-control/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,3 +147,10 @@ Example:
```

- Required: No

### `__next40pxDefaultSize`: `boolean`

Start opting into the larger default height that will become the default size in a future version.

- Required: No
- Default: `false`

0 comments on commit b0f7524

Please sign in to comment.