Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FontSizePicker: Fix FontSizePicker Storybook control type and improve documentation #68936

Merged
merged 7 commits into from
Feb 27, 2025
Merged

FontSizePicker: Fix FontSizePicker Storybook control type and improve documentation #68936

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7851f6a
Components: Improve FontSizePicker units documentation and fix unit f…
himanshupathak95 Jan 29, 2025
79e66a7
Fix failing unit tests
himanshupathak95 Jan 29, 2025
a8b6ec5
Docs: Update FontSizePicker README.md to mention the unitless mode
himanshupathak95 Feb 26, 2025
32086da
FontSizePicker: Change the storybook control type to inline-check
himanshupathak95 Feb 26, 2025
2a6ccb4
FontSizePicker: Add entry in CHANGELOG.md
himanshupathak95 Feb 26, 2025
44bbf50
Add changelog subheading - Documentation
himanshupathak95 Feb 27, 2025
dbf1a06
Move the unitless property note to value prop and reflect the same in…
himanshupathak95 Feb 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/components/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## Unreleased

### Documentation

- `FontSizePicker`: Fix Storybook units control type to use `inline-check` and improve documentation clarifying unitless mode in `README.md` ([#68936](https://github.com/WordPress/gutenberg/pull/68936)).

### Bug Fixes

- `TextControl`: Ensures email and url inputs have consistent LTR alignment in RTL languages ([#68561](https://github.com/WordPress/gutenberg/pull/68561)).
Expand Down
2 changes: 2 additions & 0 deletions packages/components/src/font-size-picker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ Available units for custom font size selection.

The current font size value.

**Note**: For the `units` property to work, the current font size value must be specified as strings with units (e.g., `'12px'` instead of `12`). When the font size is provided as a number, the component operates in "unitless mode" where the `units` property has no effect.

- Required: No

### `withReset`: `boolean`
Expand Down
4 changes: 4 additions & 0 deletions packages/components/src/font-size-picker/stories/index.story.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ const meta: Meta< typeof FontSizePicker > = {
component: FontSizePicker,
argTypes: {
value: { control: false },
units: {
control: 'inline-check',
options: [ 'px', 'em', 'rem', 'vw', 'vh' ],
},
},
parameters: {
actions: { argTypesRegex: '^on.*' },
Expand Down
4 changes: 4 additions & 0 deletions packages/components/src/font-size-picker/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ export type FontSizePickerProps = {
units?: string[];
/**
* The current font size value.
*
* Note: For the `units` property to work, the current font size value must be specified
* as strings with units (e.g., '12px' instead of 12). When the font size is provided
* as a number, the component operates in "unitless mode" where the `units` property has no effect.
*/
value?: number | string;
/**
Expand Down
Loading