@zandercraftgames/react-pdf-table

This library is designed to be used with @react-pdf/renderer.

The goal behind this library is to provide a declarative way of defining tables in a PDF.


> This NPM package was forked from @david.kucsai/react-pdf-table which seems to be abandoned.
> It has been forked with the goal of providing a maintained version that resolves some issues in the parent repository.

To get started, run:

``
npm install "@zandercraftgames/react-pdf-table"
`


Documentation

Refer to API Documentation for the type definitions.

$3

- Layout uses flex behind the scenes.
- If weighting is not defined for a table cell then it will default to the remaining unassigned weightings.
- weighting should be between 0..1. Preferably adding up to <= 1.
- If you have lots of rows to display it's recommended to batch up the rows and render them on separate pages to ensure
that values are not cut off.
- Content in TableCell and DataTableCell must either evaluate to a string or a @react-pdf/renderer component
e.g. View, Text etc. If the content is a string it will be wrapped with a Text element.
- TableCells and DataTableCells can override a lot of the configuration passed to them.

$3

#### Simple Example

This example will render a header and one row using the default styling.

`jsx



data={[
{firstName: "John", lastName: "Smith", dob: new Date(2000, 1, 1), country: "Australia", phoneNumber: "xxx-0000-0000"}
]}
>


First Name


Last Name


DOB


Country


Phone Number



r.firstName}/>
r.lastName}/>
r.dob.toLocaleString()}/>
r.country}/>
r.phoneNumber}/>





`

#### Formatting Example - Aligning Text and Weightings for columns

This example will render a header and one row using the default styling.

`jsx



data={[
{firstName: "John", lastName: "Smith", dob: new Date(2000, 1, 1), country: "Australia", phoneNumber: "xxx-0000-0000"}
]}
>


First Name


Last Name


DOB


Country


Phone Number



r.firstName}/>
r.lastName}/>
r.dob.toLocaleString()}/>
r.country}/>
r.phoneNumber}/>





`

Running Locally

To run the storybook:
`
yarn storybook
`

Compile to TypeScript:
`
yarn recompile
`

Build (Clean & Compile):
`
yarn build
`

Run tests:
`
yarn test
``