@element-public/react-notched-outline
v5.68.10-alpha.1
Published
Notched Outline component for Element React
Keywords
Readme
NotchedOutline
Description
Implements MDC notched outline feature.
Install from Artifactory
- 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-notched-outline @element/themes
- alternatively install the component individually along with the themes bundle
Notched Outline Props
| Name | Type | Default | Required | Description | | ----------- | ------ | --------- | -------- | -------------------------------------------------------------------- | | className | string | undefined | false | The css class name to be passed through to the component markup. | | closed | bool | undefined | false | Determines if the notch is opened or closed. | | outlineOnly | bool | undefined | false | Keep the outline, but prevent the notch (and label from showing up). | | width | number | null | false | |
Notched Outline Render Props
| Name | Type | Default | Required | Description | | -------- | --------------- | ------- | -------- | -------------------------------------------------------------------- | | children | React.ReactNode | null | false | Content to be rendered inside the notched outline. Accepts a string. |
