@element-public/react-floating-label
v1.0.0
Published
Floating Label component for Element React
Downloads
3
Keywords
Readme
FloatingLabel
Description
Floating Label is used to add an animated label to other components. It is not meant as a stand alone component.
Install bundle from npm-e
npm i @element-public/react-components @element-public/themes
Optional: install the component individually
npm i @element-public/react-floating-label @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=
Floating Label Props
| Name | Type | Default | Required | Description | | --------- | ------- | ------------ | -------- | ---------------------------------------------------------------- | | className | string | undefined | false | The css class name to be passed through to the component markup. | | float | boolean | false | false | The label will appear in the floating state. | | htmlFor | string | empty string | false | The id of the component to trigger on active | | shake | boolean | false | false | The label will shake briefly when set. |
Floating Label Render Props
| Name | Type | Default | Required | Description | | -------- | --------------- | ------- | -------- | ------------------------------------------------------------------------------------------- | | children | React.ReactNode | null | true | Content to be rendered inside the label. Expects a string, though accepts any valid markup. |
Floating Label Breaking Changes
| Description |
| ---------------------------------------- |
| label (removed): Use children
instead. |