Pikas UI

@pikas-ui/title

This package contains a title components that can be used to render a title.

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/title

yarn add @pikas-ui/title

pnpm add @pikas-ui/title

Usage

Title

The title component can be used to render a title.

Title H1

Title H2

Title H3

Title H4

Title H5

Title H6

import { Title } from '@pikas-ui/title';

const Example: React.FC = () => {
  return (
    <>
      <Title as="h1">Title H1</Title>
      <Title as="h2">Title H2</Title>
      <Title as="h3">Title H3</Title>
      <Title as="h4">Title H4</Title>
      <Title as="h5">Title H5</Title>
      <Title as="h6">Title H6</Title>
    </>
  );
};

Props

Prop	Description	Type	Default
`as`	The HTML tag to use for the root element.	`TitleAs`	-
`variant`	The variant to use.	`TitleVariant`	-
`textTransform`	The text transform to use.	`TitleTextTransform`	-
`css`	The css to use.	`TitleCSS`	-
`children`	The content of the component.	`ReactNode`	-

Contributing

This documentation can be edited on GitHub here