Skip to content

armgit / pdfcn

Public Imported from GitHub
0

Beautiful pdf components, built on Takumi and Forme. 100% Free, Zero config, one command setup.

2.5 KB
Raw Blame
---
title: "Text"
description: "Body text with typography variants."
---

<ComponentPreview base="forme" name="text" hideCode />

## Installation

<CodeTabs>

<TabsList>
  <TabsTrigger value="cli">Command</TabsTrigger>
  <TabsTrigger value="manual">Manual</TabsTrigger>
</TabsList>

<TabsContent value="cli">

```bash
npx shadcn@latest add @pdfcn/forme/text
```

</TabsContent>

<TabsContent value="manual">

<Steps>

<Step>Install the following dependencies:</Step>

```bash
npm install @formepdf/react @formepdf/core
```

<Step>Copy and paste the following code into your project.</Step>

<ComponentSource
  src="registry/bases/forme/components/text/text.tsx"
  base="forme"
  title="components/pdf/text/text.tsx"
/>

<ComponentSource
  src="registry/bases/forme/components/theme-provider.tsx"
  base="forme"
  title="components/pdf/theme-provider.tsx"
/>

<ComponentSource
  src="registry/bases/forme/lib/resolve-color.ts"
  base="forme"
  title="lib/resolve-color.ts"
/>

<ComponentSource
  src="registry/themes/professional.ts"
  base="forme"
  title="lib/pdf-themes/professional.ts"
/>

<ComponentSource
  src="registry/themes/primitives.ts"
  base="forme"
  title="lib/pdf-themes/primitives.ts"
/>

<ComponentSource
  src="registry/types/pdf-themes.ts"
  base="forme"
  title="types/pdf-themes.ts"
/>

<ComponentSource
  src="registry/types/pdf-components.ts"
  base="forme"
  title="types/pdf-components.ts"
/>

<Step>Update the import paths to match your project setup.</Step>

</Steps>

</TabsContent>

</CodeTabs>

## Usage

```tsx
import { Text } from "@/components/pdf/text";
```

```tsx
<Text>Hello from pdfcn</Text>
```

## API Reference

### Text

| Prop         | Type                                                       | Default    |
| ------------ | ---------------------------------------------------------- | ---------- |
| `variant`    | `'xs' \| 'sm' \| 'base' \| 'lg' \| 'xl' \| '2xl' \| '3xl'` | `'base'`   |
| `align`      | `'left' \| 'center' \| 'right' \| 'justify'`               | `'left'`   |
| `color`      | `string`                                                   | -          |
| `weight`     | `'normal' \| 'medium' \| 'semibold' \| 'bold'`             | `'normal'` |
| `italic`     | `boolean`                                                  | `false`    |
| `decoration` | `'underline' \| 'line-through' \| 'none'`                  | `'none'`   |
| `transform`  | `'uppercase' \| 'lowercase' \| 'capitalize'`               | -          |
| `noMargin`   | `boolean`                                                  | `false`    |