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 BorderRadiusControl story #67383

Open
wants to merge 5 commits into
base: trunk
Choose a base branch
from
Open
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
@@ -0,0 +1,78 @@
# BorderRadiusControl

`BorderRadiusControl` is a React component that provides a user interface for managing border radius values. It allows users to control the border radius of each corner independently or link them together for uniform values.

## Usage

```jsx
/**
* WordPress dependencies
*/
import { BorderRadiusControl } from '@wordpress/block-editor';
import { useState } from '@wordpress/element';

const MyBorderRadiusControl = () => {
const [values, setValues] = useState({
topLeft: '10px',
topRight: '10px',
bottomLeft: '10px',
bottomRight: '10px',
});

return (
<BorderRadiusControl
values={values}
onChange={setValues}
/>
);
};

// ...

<MyBorderRadiusControl />;
```

## Props

The component accepts the following props:

### values

An object containing the border radius values for each corner.

- **Type:** `Object`
- **Required:** No
- **Default:** `{ topLeft: undefined, topRight: undefined, bottomLeft: undefined, bottomRight: undefined }`

The values object has the following schema:

| Property | Description | Type |
| ----------- | ------------------------------------ | ------ |
| topLeft | Border radius for top left corner | string |
| topRight | Border radius for top right corner | string |
| bottomLeft | Border radius for bottom left corner | string |
| bottomRight | Border radius for bottom right corner| string |

Each value should be a valid CSS border radius value (e.g., '10px', '1em').

### onChange

Callback function that is called when any border radius value changes.

- **Type:** `Function`
- **Required:** Yes
- **Default:** `() => {}`

The function receives the updated values object as its argument.

## Limitations

The component has the following built-in constraints:

- Minimum border radius value: 0
- Maximum values by unit:
- px: 100
- em: 20
- rem: 20

Please refer to the component's stories for more examples of usage.
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
/**
* WordPress dependencies
*/
import { useState } from '@wordpress/element';

/**
* Internal dependencies
*/
import BorderRadiusControl from '../';

const meta = {
title: 'BlockEditor/BorderRadiusControl',
component: BorderRadiusControl,
parameters: {
docs: {
canvas: { sourceState: 'shown' },
description: {
component: 'Control to display border radius options.',
},
},
},
argTypes: {
values: {
control: 'object',
description: 'Border radius values.',
table: {
type: { summary: 'object' },
},
},
onChange: {
action: 'onChange',
control: { type: null },
table: {
type: { summary: 'function' },
},
description: 'Callback to handle onChange.',
},
},
};

export default meta;

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

return (
<BorderRadiusControl
{ ...args }
values={ values }
onChange={ ( ...changeArgs ) => {
setValues( ...changeArgs );
onChange( ...changeArgs );
} }
/>
);
},
args: {
values: {
topLeft: '10px',
topRight: '10px',
bottomLeft: '10px',
bottomRight: '10px',
},
},
};
Loading