1.0.0 • Published 11 months ago

@element-public/react-floating-label v1.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
11 months ago

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

NameTypeDefaultRequiredDescription
classNamestringundefinedfalseThe css class name to be passed through to the component markup.
floatbooleanfalsefalseThe label will appear in the floating state.
htmlForstringempty stringfalseThe id of the component to trigger on active
shakebooleanfalsefalseThe label will shake briefly when set.

Floating Label Render Props

NameTypeDefaultRequiredDescription
childrenReact.ReactNodenulltrueContent to be rendered inside the label. Expects a string, though accepts any valid markup.

Floating Label Breaking Changes

Description
label (removed): Use children instead.