Skip to content

Commit

Permalink
docs: inform that field-label should provide a text label for the field
Browse files Browse the repository at this point in the history
Co-Authored-By: Andre Luiz Rabello <andre.luiz_r@hotmail.com>
  • Loading branch information
Julius Osokinas and rabelloo committed Feb 9, 2021
1 parent b24becf commit 1d7ba45
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions packages/react/src/components/field-label/field-label.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@ import { c, classy } from '@onfido/castor';
import React from 'react';

/**
* Intended to be used within `Input` and `Textarea` components.
* Intended to be used within `Input` and `Textarea` components, providing a
* text label for the field.
*
* Can also be used alongside these components, but should then be connected via
* the "htmlFor" prop.
* Can also be used alongside these two components, but should then be connected
* via the "htmlFor" prop.
*/
export const FieldLabel = ({
className,
Expand Down

0 comments on commit 1d7ba45

Please sign in to comment.