# Halftone Dots

> A halftone-dot image filter featuring customizable grids, color palettes, and dot styles. Ported from Paper Shaders (Apache-2.0).

<demo-paper-halftone-dots>



</demo-paper-halftone-dots>

## Installation

```bash
npx shadcn-vue@latest add "https://nxui.geoql.in/r/paper-halftone-dots.json"
```

## Usage

```vue
<script setup lang="ts">
  import PaperHalftoneDots from '~/components/ui/paper-halftone-dots/PaperHalftoneDots.vue';
</script>

<template>
  <div class="relative h-100 w-full overflow-hidden rounded-lg">
    <PaperHalftoneDots
      :image="'/flowers.webp'"
      :color-front="'#2b2b2b'"
      :color-back="'#f2f1e8'"
      :size="0.5"
      :radius="1.25"
      :contrast="0.4"
      :grid="'hex'"
      :type="'gooey'"
    />
  </div>
</template>
```

## Props

<table>
<thead>
  <tr>
    <th>
      Prop
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Default
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        image
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      <code>
        ''
      </code>
    </td>
    
    <td>
      Source image URL to apply the halftone filter to
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        color-front
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      <code>
        '#2b2b2b'
      </code>
    </td>
    
    <td>
      Foreground (dot) color in RGBA
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        color-back
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      <code>
        '#f2f1e8'
      </code>
    </td>
    
    <td>
      Background (paper) color in RGBA
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        size
      </code>
    </td>
    
    <td>
      <code>
        number
      </code>
    </td>
    
    <td>
      <code>
        0.5
      </code>
    </td>
    
    <td>
      Grid size relative to the image box (0 to 1)
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        grid
      </code>
    </td>
    
    <td>
      <code>
        'square' | 'hex'
      </code>
    </td>
    
    <td>
      <code>
        'hex'
      </code>
    </td>
    
    <td>
      Grid style
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        radius
      </code>
    </td>
    
    <td>
      <code>
        number
      </code>
    </td>
    
    <td>
      <code>
        1.25
      </code>
    </td>
    
    <td>
      Maximum dot size relative to grid cell (0 to 2)
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        contrast
      </code>
    </td>
    
    <td>
      <code>
        number
      </code>
    </td>
    
    <td>
      <code>
        0.4
      </code>
    </td>
    
    <td>
      Contrast applied to the sampled image (0 to 1)
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        original-colors
      </code>
    </td>
    
    <td>
      <code>
        boolean
      </code>
    </td>
    
    <td>
      <code>
        false
      </code>
    </td>
    
    <td>
      Use sampled image's original colors
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        inverted
      </code>
    </td>
    
    <td>
      <code>
        boolean
      </code>
    </td>
    
    <td>
      <code>
        false
      </code>
    </td>
    
    <td>
      Inverts the image luminance
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        grain-mixer
      </code>
    </td>
    
    <td>
      <code>
        number
      </code>
    </td>
    
    <td>
      <code>
        0.2
      </code>
    </td>
    
    <td>
      Strength of grain distortion on shape edges (0 to 1)
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        grain-overlay
      </code>
    </td>
    
    <td>
      <code>
        number
      </code>
    </td>
    
    <td>
      <code>
        0.2
      </code>
    </td>
    
    <td>
      Post-processing black/white grain overlay (0 to 1)
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        grain-size
      </code>
    </td>
    
    <td>
      <code>
        number
      </code>
    </td>
    
    <td>
      <code>
        0.5
      </code>
    </td>
    
    <td>
      Scale applied to grain effects (0 to 1)
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        type
      </code>
    </td>
    
    <td>
      <code>
        'classic' | 'gooey' | 'holes' | 'soft'
      </code>
    </td>
    
    <td>
      <code>
        'gooey'
      </code>
    </td>
    
    <td>
      Dot style
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        speed
      </code>
    </td>
    
    <td>
      <code>
        number
      </code>
    </td>
    
    <td>
      <code>
        0
      </code>
    </td>
    
    <td>
      Animation speed multiplier (0 freezes)
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        frame
      </code>
    </td>
    
    <td>
      <code>
        number
      </code>
    </td>
    
    <td>
      <code>
        0
      </code>
    </td>
    
    <td>
      Initial/seek frame for deterministic rendering
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        fit
      </code>
    </td>
    
    <td>
      <code>
        'none' | 'contain' | 'cover'
      </code>
    </td>
    
    <td>
      <code>
        'cover'
      </code>
    </td>
    
    <td>
      How the graphic fits the canvas
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        scale
      </code>
    </td>
    
    <td>
      <code>
        number
      </code>
    </td>
    
    <td>
      <code>
        1
      </code>
    </td>
    
    <td>
      Overall zoom level (0.01 to 4)
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        rotation
      </code>
    </td>
    
    <td>
      <code>
        number
      </code>
    </td>
    
    <td>
      <code>
        0
      </code>
    </td>
    
    <td>
      Overall rotation in degrees (0 to 360)
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        origin-x
      </code>
    </td>
    
    <td>
      <code>
        number
      </code>
    </td>
    
    <td>
      <code>
        0.5
      </code>
    </td>
    
    <td>
      Horizontal origin for world positioning (0 to 1)
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        origin-y
      </code>
    </td>
    
    <td>
      <code>
        number
      </code>
    </td>
    
    <td>
      <code>
        0.5
      </code>
    </td>
    
    <td>
      Vertical origin for world positioning (0 to 1)
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        offset-x
      </code>
    </td>
    
    <td>
      <code>
        number
      </code>
    </td>
    
    <td>
      <code>
        0
      </code>
    </td>
    
    <td>
      Horizontal offset of the graphics center (-1 to 1)
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        offset-y
      </code>
    </td>
    
    <td>
      <code>
        number
      </code>
    </td>
    
    <td>
      <code>
        0
      </code>
    </td>
    
    <td>
      Vertical offset of the graphics center (-1 to 1)
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        world-width
      </code>
    </td>
    
    <td>
      <code>
        number
      </code>
    </td>
    
    <td>
      <code>
        0
      </code>
    </td>
    
    <td>
      Virtual world width before canvas fitting
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        world-height
      </code>
    </td>
    
    <td>
      <code>
        number
      </code>
    </td>
    
    <td>
      <code>
        0
      </code>
    </td>
    
    <td>
      Virtual world height before canvas fitting
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        class
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      —
    </td>
    
    <td>
      Additional CSS classes
    </td>
  </tr>
</tbody>
</table>

## Attribution

Powered by [Paper Shaders](https://github.com/paper-design/shaders)
(© Lost Coast Labs, Inc., Apache-2.0) via the framework-agnostic
`@paper-design/shaders` package driven by a Vue 3 mount. This is an
unofficial community port; it is not maintained by Paper.
