Provides tables for the @react-pdf/renderer.
npm install @david.kucsai/react-pdf-tableThis 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.
To get started run:
``
npm install "@david.kucsai/react-pdf-table"
On Windows you must escape the '.':
npm install "@david
``
Refer to API Documentation for the type definitions.
- Layout uses flex behind the scenes. weighting
- If 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.TableCell
- 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 and DataTableCell must either evaluate to a string or a @react-pdf/renderer componentView
e.g. , Text etc. If the content is a string it will be wrapped with a Text element.TableCell
- s and DataTableCells can override a lot of the configuration passed to them.
#### Simple Example
This example will render a header and one row using the default styling.
`jsx`
{firstName: "John", lastName: "Smith", dob: new Date(2000, 1, 1), country: "Australia", phoneNumber: "xxx-0000-0000"}
]}
>
First Name
Last Name
DOB
Country
Phone Number
#### Formatting Example - Aligning Text and Weightings for columns
This example will render a header and one row using the default styling.
`jsx`
{firstName: "John", lastName: "Smith", dob: new Date(2000, 1, 1), country: "Australia", phoneNumber: "xxx-0000-0000"}
]}
>
First Name
Last Name
DOB
Country
Phone Number
To run the storybook:
`
yarn storybook
Compile to typescript:
`
yarn recompile
Build (Clean & Compile):
`
yarn build
Run tests:
`
yarn test