# Shipping Label

Print-ready 4x6 shipping label with sender, recipient, barcode area, and carrier info.

> For the complete documentation index, see [llms.txt](/llms.txt). Markdown variants are available by appending `.md` to any URL or sending an `Accept: text/markdown` header. An agent skill is available at [/.well-known/agent-skills/site-skill.md](/.well-known/agent-skills/site-skill.md).



<ComponentPreview base="takumi" name="shipping-label" />

## Installation [#installation]

<CodeTabs>
  <TabsList>
    <TabsTrigger value="cli">
      Command
    </TabsTrigger>

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

  <TabsContent value="cli">
    ```bash
    npx shadcn@latest add @pdfcn/takumi/shipping-label
    ```
  </TabsContent>

  <TabsContent value="manual">
    <Steps>
      <Step>
        Install the following dependencies:
      </Step>

      ```bash
      npm install takumi-pdf @takumi-rs/helpers qrcode
      ```

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

      <ComponentSource src="registry/bases/takumi/blocks/shipping-label/shipping-label.tsx" base="takumi" title="components/pdf/blocks/shipping-label/shipping-label.tsx" />

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

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

      <ComponentSource src="registry/bases/takumi/lib/pdf-primitives.tsx" base="takumi" title="lib/pdf-primitives.tsx" />

      <ComponentSource src="registry/bases/takumi/lib/pdf-svg.tsx" base="takumi" title="lib/pdf-svg.tsx" />

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

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

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

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

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

## Usage [#usage]

```tsx
import { ShippingLabelDocument } from "@/components/pdf/shipping-label";
```

```tsx
<ShippingLabelDocument
  data={{
    carrier: "UPS",
    serviceLevel: "Ground",
    trackingNumber: "1Z999AA10123456784",
    from: {
      name: "Acme Warehouse",
      address: "100 Industrial Blvd",
      city: "Seattle",
      state: "WA",
      zip: "98101",
    },
    to: {
      name: "Jane Doe",
      address: "456 Oak Ave, Apt 12",
      city: "Portland",
      state: "OR",
      zip: "97201",
      phone: "(503) 555-0142",
    },
    weight: "4.2 lbs",
    dimensions: '12" x 8" x 6"',
    handlingLabels: ["FRAGILE"],
    accentColor: "#1d4ed8",
  }}
/>
```

### With a carrier barcode image [#with-a-carrier-barcode-image]

Provide `barcodeUrl` to render a full-width barcode image instead of the QR code:

```tsx
<ShippingLabelDocument
  data={{
    // ...
    trackingNumber: "1Z999AA10123456784",
    barcodeUrl: "https://example.com/barcodes/1Z999AA10123456784.png",
  }}
/>
```

## Props [#props]

| Prop    | Type                | Description                                                      |
| ------- | ------------------- | ---------------------------------------------------------------- |
| `data`  | `ShippingLabelData` | Label content: addresses, carrier, tracking, and package details |
| `theme` | `PdfcnTheme`        | Optional theme override                                          |