Padding component for Element React
Padding is used for adding consistent padding to layouts.
- Verify that you have access to (https://docs.int.bayer.com/cloud/devops/artifactory/)[Bayer Artifactory]
- Verify your token is correctly set up in your .npmrc as per the link above
- Verify you have the @element scope configured in your .npmrc
- @element:registry=https://artifactory.bayer.com/artifactory/api/npm/npm-platforms-engineering/
- Install the component and themes bundles
- npm i @element/react-components @element/themes
- alternatively install the component individually along with the themes bundle npm i @element/react-padding @element/themes
Padding is used to add additional space around content to improve readability and the user experience. A few important props for Padding include variant, which includes three preset Padding values - dense, standard, and airy, and customPadding, which allows a different amount of Padding to be applied around an item, rather than one of the three preset options. Custom Padding must be a valid CSS Padding declaration. i.e. 38px 30px. Setting customPadding will overwrite the variant padding if both are set.
Padding can be used with many components including Typobody, as shown in the Storybook demo. Additional use cases include putting space in between Buttons and other components when arranging them in a larger object, like a form.
| Name | Type | Default | Required | Description |
| ------------- | ------------------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| className | string | undefined | false | The css class name to be passed through to the component markup. |
| customPadding | string | null | false | Adds a custom padding style to the child content. Must be a valid CSS padding declaration. i.e. 38px 30px |
| tag | string\|React.ElementType | 'div' | false | By default a div will be rendered, this allow another tag to be used instead. A block type component is suggested. |
| variant | string | 'standard' | false | Applies the specified padding amount. dense is 8px, standard is 16px, and airy is 24px. If customPadding is used, this will be ignored.
Accepted Values: dense, standard, airy |
| Name | Type | Default | Required | Description |
| -------- | --------------- | ------- | -------- | ------------------------------------------------------------------------------ |
| children | React.ReactNode | null | true | Content to be rendered inside the padding component. Accepts any valid markup. |