# @bdt-component-library/input-label

> Input Label component

Latest version **0.4.6** (published 2021-12-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install @bdt-component-library/input-label
pnpm add @bdt-component-library/input-label
yarn add @bdt-component-library/input-label
bun add @bdt-component-library/input-label
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.6 |
| Published | 2021-12-06 |
| First published | 2021-01-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 1.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | BDT |
| Maintainers | benefitsdatatrust, gabrielliwerant |

## Links

- npm: https://www.npmjs.com/package/@bdt-component-library/input-label
- Repository: https://github.com/BenefitsDataTrust/ui-components
- Homepage: https://github.com/BenefitsDataTrust/ui-components#readme
- Issues: https://github.com/BenefitsDataTrust/ui-components/issues
- npm.io page: https://npm.io/package/@bdt-component-library/input-label

## Dependencies (1)

- [classnames](https://npm.io/package/classnames.md) ^2.3.1

## Recent versions

- 0.4.6 (latest) — 2021-12-06
- 0.4.5 — 2021-11-23
- 0.4.4 — 2021-11-16
- 0.4.3 — 2021-11-01
- 0.4.2 — 2021-10-11
- 0.4.1 — 2021-09-24
- 0.4.0 — 2021-07-20
- 0.3.0 — 2021-06-30
- 0.2.3 — 2021-06-15
- 0.2.2 — 2021-06-04
- 0.2.1 — 2021-05-25
- 0.2.0 — 2021-05-14
- 0.1.2 — 2021-03-30
- 0.1.1 — 2021-01-27
- 0.1.0 — 2021-01-21

## README

# InputLabel Component

## About

This is a component published as its own package from our component library monorepo: https://github.com/BenefitsDataTrust/ui-components. Setup instructions, as well as higher-level goals and concerns can be found from the main project [README](https://github.com/BenefitsDataTrust/ui-components/blob/develop/README.md).

## Description

Handles display of input labels according to style guide conventions.

- https://zeroheight.com/990ea04ab/p/98b6fb-input-fields

## API

| prop      | type   | required | default | explanation  |
|-----------|--------|----------|---------|--------------|
| className | string | no | "" | Adds an optional classname to the component |
| label | string | yes | n/a | The text for the input label |
| hideLabel | boolean | no | n/a | Sets whether the label is intended for screen readers only |
| htmlFor | string | yes | n/a | Sets the label for attr |
| required | boolean | no | false | Determines whether or not the label is for a required input |
| disabled | boolean | no | false | Determines label disabled state |
| clickable | boolean | no | false | Determines if the label should have cursor pointer effects |
| noBottomMargin | boolean | no | false | Determines whether or not the label has a bottom margin |
| nativeRequired | boolean | no | false | Determines whether or not the label is for a required input |
| onClick | function(e: event) | no | () => {} | Event handler for onclick event on the label |

---
_Source: https://npm.io/package/@bdt-component-library/input-label · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._