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.

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

Storybook : Add TextTransformControl stories #67365

Merged
merged 5 commits into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# TextTransformControl

The `TextTransformControl` component is responsible for rendering a control element that allows users to select and apply text transformation options to blocks or elements in the Gutenberg editor. It provides an intuitive interface for changing the text appearance by applying different transformations such as `none`, `uppercase`, `lowercase`, `capitalize`.

![TextTransformConrol Element in Inspector Control](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/text-transform-component.png?raw=true)

## Development guidelines
Expand All @@ -28,7 +28,6 @@ const MyTextTransformControlComponent = () => (
### `value`

- **Type:** `String`
- **Default:** `none`
- **Options:** `none`, `uppercase`, `lowercase`, `capitalize`

The current value of the Text Transform setting. You may only choose from the `Options` listed above.
Expand All @@ -37,4 +36,4 @@ The current value of the Text Transform setting. You may only choose from the `O

- **Type:** `Function`

A callback function invoked when the Text Transform value is changed via an interaction with any of the buttons. Called with the Text Transform value (`none`, `uppercase`, `lowercase`, `capitalize`) as the only argument.
A callback function invoked when the Text Transform value is changed via an interaction with any of the buttons. Called with the Text Transform value (`none`, `uppercase`, `lowercase`, `capitalize`) as the only argument.
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,63 @@ import { useState } from '@wordpress/element';
*/
import TextTransformControl from '../';

export default {
const meta = {
title: 'BlockEditor/TextTransformControl',
component: TextTransformControl,
parameters: {
docs: {
canvas: { sourceState: 'shown' },
description: {
component:
'Control to facilitate text transformation selections.',
},
},
},
argTypes: {
onChange: { action: 'onChange' },
onChange: {
action: 'onChange',
control: {
type: null,
},
description: 'Handles change in text transform selection.',
table: {
type: {
summary: 'function',
},
},
},
className: {
control: { type: 'text' },
description: 'Class name to add to the control.',
table: {
type: { summary: 'string' },
},
},
value: {
control: { type: null },
description: 'Currently selected text transform.',
table: {
type: { summary: 'string' },
},
},
t-hamano marked this conversation as resolved.
Show resolved Hide resolved
},
};

const Template = ( { onChange, ...args } ) => {
const [ value, setValue ] = useState();
return (
<TextTransformControl
{ ...args }
onChange={ ( ...changeArgs ) => {
onChange( ...changeArgs );
setValue( ...changeArgs );
} }
value={ value }
/>
);
};
export default meta;

export const Default = {
render: function Template( { onChange, ...args } ) {
const [ value, setValue ] = useState();

export const Default = Template.bind( {} );
return (
<TextTransformControl
{ ...args }
onChange={ ( ...changeArgs ) => {
onChange( ...changeArgs );
setValue( ...changeArgs );
} }
value={ value }
/>
);
},
};
Loading