@element-public/react-padding NPM

Padding

Description

Padding is used for adding consistent padding to layouts.

See live demos on storybook

Install bundle from npm-e

npm i @element-public/react-components @element-public/themes

Optional: install the component individually

npm i @element-public/react-padding @element-public/themes

Open ~/.npmrc in an editor and add the following line to enable the @element-public scope:

@element-public:registry=https://npm.platforms.engineering

Troubleshooting

See below if you have never installed a package from Bayer's npm-enterprise or run into the following error:

npm ERR! code E401
npm ERR! Unable to authenticate, your authentication token seems to be invalid.
npm ERR! To correct this please trying logging in again with:
npm ERR!     npm login

Setup an access token

See the devtools npm-e guide to learn how to create an access token if this is the first time you are using a npm-e package at Bayer or you do not have a line that starts with the following in your ~/.npmrc file:

//npm.platforms.engineering/:_authToken=

Notes

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.

Usage

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.

Padding Props

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

Padding Render Props

Name	Type	Default	Required	Description
children	React.ReactNode	null	true	Content to be rendered inside the padding component. Accepts any valid markup.

clsx prop-types @babel/runtime-corejs3

@element-public/react-components

1.0.0

1 year ago