@pikas-ui/text

This package contains a set of components to display text.

Change Log

Requirements

To use this package, you must install the @pikas-ui/styles package.

Installation

You can install this package using npm, yarn, or pnpm.

npm install @pikas-ui/text
yarn add @pikas-ui/text
pnpm add @pikas-ui/text

Usage

Label

With the Label component you can create a label for a form field.

import { Label } from '@pikas-ui/text';

const Example: React.FC = () => {
  return <Label>Label</Label>;
};

Props

PropDescriptionTypeDefault
htmlForThe id of the label.string-
cssThe css of the label.PikasCSS-
childrenThe text of the label.ReactNode-

Description

With the Description component you can add a description.

Description

import { Description } from '@pikas-ui/text';

const Example: React.FC = () => {
  return <Description>Description</Description>;
};

Props

PropDescriptionTypeDefault
cssThe css of the description.PikasCSS-
childrenThe text of the description.ReactNode-

TextError

With the TextError component you can display an error message.

TextError

import { TextError } from '@pikas-ui/text';

const Example: React.FC = () => {
  return <TextError>TextError</TextError>;
};

Props

PropDescriptionTypeDefault
cssThe css of the text error.PikasCSS-
childrenThe text of the text error.ReactNode-

Contributing

This documentation can be edited on GitHub here