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.4 KB
Raw Blame
---
title: "Stack"
description: "Vertical stack with spacing."
---

<ComponentPreview base="forme" name="stack" 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/stack
```

</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/stack/stack.tsx"
  base="forme"
  title="components/pdf/stack/stack.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 { Stack } from "@/components/pdf/stack";
import { Text } from "@/components/pdf/text";
```

```tsx
<Stack gap="md">
  <Text>One</Text>
  <Text>Two</Text>
</Stack>
```

## API Reference

### Stack

| Prop        | Type                                                    | Default    |
| ----------- | ------------------------------------------------------- | ---------- |
| `gap`       | `'none' \| 'sm' \| 'md' \| 'lg' \| 'xl'`                | 'md'       |
| `direction` | `'vertical' \| 'horizontal'`                            | 'vertical' |
| `align`     | `'start' \| 'center' \| 'end' \| 'stretch'`             | 'start'    |
| `justify`   | `'start' \| 'center' \| 'end' \| 'between' \| 'around'` | 'start'    |
| `wrap`      | `boolean`                                               | false      |
| `noWrap`    | `boolean`                                               | false      |