# Brand Mark

A logo image with a placeholder tile fallback for monograms or icons.

> 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 name="brand-mark" />

## Installation [#installation]

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

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

  <TabsContent value="cli">
    ```bash
    npx shadcn@latest add @ogimagecn/brand-mark
    ```
  </TabsContent>

  <TabsContent value="manual">
    <Steps>
      <Step>
        Copy and paste the following code into your project.
      </Step>

      <ComponentSource name="brand-mark" title="components/og/brand-mark.tsx" />

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

## Usage [#usage]

```tsx
import { BrandMark } from "@/components/og/brand-mark";
```

```tsx
<BrandMark src={logoUrl} size={40} radius={8} background="#7c3aed">
  A
</BrandMark>
```

## API Reference [#api-reference]

| Prop         | Type                   | Default     |
| ------------ | ---------------------- | ----------- |
| `src`        | `string`               | —           |
| `size`       | `number`               | `40`        |
| `radius`     | `number \| string`     | `8`         |
| `background` | `string`               | —           |
| `fit`        | `"contain" \| "cover"` | `"contain"` |
| `children`   | `ReactNode`            | —           |
| `style`      | `CSSProperties`        | —           |