Spaces:
Running
Running
File size: 3,431 Bytes
391a73c | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 | <p align="center">
<img src="https://user-images.githubusercontent.com/5600341/27505816-c8bc37aa-587f-11e7-9a86-08a2d081a8b9.png" height="280px">
</p>
# @react-pdf/primitives
Internal element type constants for react-pdf. This package defines the primitive node types used throughout the react-pdf rendering pipeline.
## Installation
```bash
yarn add @react-pdf/primitives
```
## Usage
```js
import { View, Text, Page, Document } from '@react-pdf/primitives';
console.log(View); // 'VIEW'
console.log(Text); // 'TEXT'
console.log(Page); // 'PAGE'
console.log(Document); // 'DOCUMENT'
```
These constants are primarily used internally by react-pdf packages to identify element types during the rendering process.
## Available Primitives
### Document Structure
| Export | Value | Description |
| ---------- | ------------ | --------------------------------- |
| `Document` | `'DOCUMENT'` | Root document container |
| `Page` | `'PAGE'` | Individual page within a document |
| `View` | `'VIEW'` | Generic container element |
| `Text` | `'TEXT'` | Text content container |
| `Link` | `'LINK'` | Hyperlink element |
| `Note` | `'NOTE'` | Annotation/note element |
| `Image` | `'IMAGE'` | Image element |
| `Canvas` | `'CANVAS'` | Custom drawing canvas |
### Form Elements
| Export | Value | Description |
| ----------- | -------------- | ----------------------------- |
| `FieldSet` | `'FIELD_SET'` | Form field grouping container |
| `TextInput` | `'TEXT_INPUT'` | Text input field |
| `Select` | `'SELECT'` | Dropdown select field |
| `Checkbox` | `'CHECKBOX'` | Checkbox input field |
| `List` | `'LIST'` | List element for forms |
### SVG Elements
| Export | Value | Description |
| ---------------- | ------------------- | -------------------------- |
| `Svg` | `'SVG'` | SVG root container |
| `G` | `'G'` | SVG group element |
| `Path` | `'PATH'` | SVG path element |
| `Rect` | `'RECT'` | SVG rectangle element |
| `Line` | `'LINE'` | SVG line element |
| `Circle` | `'CIRCLE'` | SVG circle element |
| `Ellipse` | `'ELLIPSE'` | SVG ellipse element |
| `Polygon` | `'POLYGON'` | SVG polygon element |
| `Polyline` | `'POLYLINE'` | SVG polyline element |
| `Tspan` | `'TSPAN'` | SVG text span element |
| `ClipPath` | `'CLIP_PATH'` | SVG clipping path |
| `Defs` | `'DEFS'` | SVG definitions container |
| `Stop` | `'STOP'` | Gradient stop element |
| `LinearGradient` | `'LINEAR_GRADIENT'` | Linear gradient definition |
| `RadialGradient` | `'RADIAL_GRADIENT'` | Radial gradient definition |
### Internal Types
| Export | Value | Description |
| -------------- | ----------------- | --------------------------------------- |
| `TextInstance` | `'TEXT_INSTANCE'` | Internal representation of text content |
## License
MIT
|