a86e387667
* Update `jest-puppeteer@5.0.4` (from `4.4.0`) to be albe to run with jest 28. * Update `jest` and `ts-jest@^27` (from `25`), to match `e2e-environment` needs. * Update api-core-tests' `jest@^27` (from `25`), to unify the used version across the stack. * Update e2e-env's `jest@^27` & co. (from `25`), to unify the used version across the stack. * Update e2e-env's `@jest/test-sequencer@^27` (from `25`), to unify the used version across the stack. * Update admin-e2e-tests' `@jest/globals@^27` (from `26`), to unify the used version across the stack. * Update woocommerce's `jest@^27.5.1` (from `25`), to unify the used version across the stack. * Replace `mocked` from `ts-jest` to the one from `jest`, Update `@types/jest@27.4.1` from `27.0.2`. Try to fix broken tsc build. * Update `e2e-core-tests`' `@jest/globals@^27.5.1` from `^26.4.2`. * Remove changelog entry for bumpin jest in `api-core-tests` It was already covered in `trunk`. Addresses https://github.com/woocommerce/woocommerce/pull/34322#discussion_r956019567 * Updated package-lock.yaml * Updated timeout * Added changelogs Co-authored-by: jamelreid <jnoelreid@gmail.com> |
||
---|---|---|
.. | ||
changelog | ||
src | ||
typings | ||
.eslintrc.js | ||
.gitignore | ||
.npmrc | ||
CHANGELOG.md | ||
PREVIOUS_CHANGELOG.md | ||
README.md | ||
babel.config.js | ||
composer.json | ||
composer.lock | ||
jest.config.json | ||
package.json | ||
tsconfig-cjs.json | ||
tsconfig.json |
README.md
CSV Export
A set of functions to convert data into CSV values, and enable a browser download of the CSV data.
Installation
Install the module
pnpm install @woocommerce/csv-export --save
Usage
onClick = () => {
// Create a file name based on a title and optional query. Will return a timestamped
// name, for example: revenue-2018-11-01-interval-month.csv
const name = generateCSVFileName( 'revenue', { interval: 'month' } );
// Create a string of CSV data, `headers` is an array of row headers, put at the top
// of the file. `rows` is a 2 dimensional array. Each array is a line in the file,
// separated by newlines. The second-level arrays are the data points in each row.
// For header format, see https://woocommerce.github.io/woocommerce-admin/#/components/table?id=headers-2
// For rows format, see https://woocommerce.github.io/woocommerce-admin/#/components/table?id=rows-1
const data = generateCSVDataFromTable( headers, rows );
// Triggers a browser UI to save a file, named the first argument, with the contents of
// the second argument.
downloadCSVFile( name, data );
}
generateCSVDataFromTable(headers, rows) ⇒ String
Generates a CSV string from table contents
Returns: String
- Table contents in a CSV format
Param | Type | Description |
---|---|---|
headers | Array.<Object> |
Object with table header information |
rows | Array.Array.<Object> |
Object with table rows information |
generateCSVFileName([name], [params]) ⇒ String
Generates a file name for CSV files based on the provided name, the current date and the provided params, which are all appended with hyphens.
Returns: String
- Formatted file name
Param | Type | Default | Description |
---|---|---|---|
[name] | String |
'' |
Name of the file |
[params] | Object |
{} |
Object of key-values to append to the file name |
downloadCSVFile(fileName, content)
Downloads a CSV file with the given file name and contents
Param | Type | Description |
---|---|---|
fileName | String |
Name of the file to download |
content | String |
Contents of the file to download |