Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/openscript-ch/react-dsv-import
Flexible, typed and easy to use React Component ⚛ to provide CSV, TSV and other delimiter-separated values formats (DSV) import functionality.
https://github.com/openscript-ch/react-dsv-import
codeclimate csv dsv react react-component storybook tsv typescript vitejs
Last synced: 3 months ago
JSON representation
Flexible, typed and easy to use React Component ⚛ to provide CSV, TSV and other delimiter-separated values formats (DSV) import functionality.
- Host: GitHub
- URL: https://github.com/openscript-ch/react-dsv-import
- Owner: openscript-ch
- License: agpl-3.0
- Created: 2020-04-10T11:11:09.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-21T07:38:00.000Z (3 months ago)
- Last Synced: 2024-10-21T10:42:53.174Z (3 months ago)
- Topics: codeclimate, csv, dsv, react, react-component, storybook, tsv, typescript, vitejs
- Language: TypeScript
- Homepage: https://openscript-ch.github.io/react-dsv-import/
- Size: 14.6 MB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# react-dsv-import
Flexible, typed and easy to use React Component ⚛ to provide CSV, TSV and other delimiter-separated values formats ([DSV](https://en.wikipedia.org/wiki/Delimiter-separated_values)) import functionality.
[](https://www.npmjs.com/package/react-dsv-import)
[](https://www.npmjs.com/package/react)
[](https://github.com/openscript-ch/react-dsv-import)
[](https://codeclimate.com/github/openscript/react-dsv-import/maintainability)
[](https://codeclimate.com/github/openscript/react-dsv-import/test_coverage)
## Getting started
Add the package with the package manager of choice to your project:
- **yarn**: `yarn add react-dsv-import`
- **npm**: `npm install react-dsv-import`
- **npx**: `npx -p react-dsv-import`
### TypeScript
```
import { DSVImport, ColumnsType } from 'react-dsv-import';
type BasicType = { forename: string; surname: string; email: string };
const columns: ColumnsType = [
{ key: 'forename', label: 'Forename' },
{ key: 'surname', label: 'Surname' },
{ key: 'email', label: 'Email' }
];
columns={columns}>
```
### JavaScript
```
import { DSVImport } from 'react-dsv-import';
const columns = [
{ key: 'forename', label: 'Forename' },
{ key: 'surname', label: 'Surname' },
{ key: 'email', label: 'Email' }
];
```
## API
The `>` components has the following API:
| Property | Type | Description |
| :-------------- | :------------------------------ | :------------------------------------------------------ |
| `columns` | [ColumnType](#columntype) | Description of the expected columns |
| `transformers?` | [Transformer](#transformer)`[]` | Globally applied transformers |
| `onChange?` | `(value: T[]) => void` | Callback which is called after parsing the input |
| `onValidation?` | `(errors: Error[]) => void` | Callback which is called if there are validation errors |
### Types
Within this section additional types are explained.
#### ColumnType
| Property | Type | Description |
| :-------------- | :------------------------------ | :---------------------------------------------------------- |
| `key` | `string` | Key of the current column |
| `label` | `string` | Label of the current column, which can be shown to the user |
| `rules?` | [Rule](#rule)`[]` | Validation rules which are applied to this column |
| `transformers?` | [Transformer](#transformer)`[]` | Transformers which are applied to this column |
#### Rule
| Property | Type | Description |
| :---------- | :------------------------------------------------------------------ | :----------------------- |
| `message` | `string` | Error message |
| `contraint` | `{ unique: boolean } \| { constraint: `[Constraint](#constraint)`}` | Constraint for this rule |
#### Constraint
`(value: string) => boolean`
#### Transformer
`(value: string) => string`
## Project
This section describes the status of the project.
### Features
The most important features of this component are:
- ✅ Type definitions and type safety
- ✅ DSV format detection
- ✅ Fully compositable
- ✅ Automatic testing with >90% coverage
- ✅ Input validation
- ✅ [Ant Design](https://ant.design/) integration (see storybook)
- ✅ Input transformation (e.g. trim, ...)
- ❌ [Material UI](https://material-ui.com/) integration (see storybook)
✅ means the feature is implemented and released. ❌ indicates that a feature is planned.
### Links
- [Code repository](https://github.com/openscript-ch/react-dsv-import)
- [Build status](https://travis-ci.com/github/openscript/react-dsv-import)
- [Documenation and examples](https://openscript.github.io/react-dsv-import)
- [Package publication](https://www.npmjs.com/package/react-dsv-import)
- [Code quality evaluation](https://codeclimate.com/github/openscript/react-dsv-import)
## Tools
- [yarn](https://yarnpkg.com/)
- [rollup.js](https://rollupjs.org/)
- [TypeScript](https://www.typescriptlang.org/)
- [TypeScript ESLint](https://typescript-eslint.io/)
- [React](https://reactjs.org/)
- [Storybook](https://storybook.js.org/)
- [Addon: Docs](https://github.com/storybookjs/storybook/tree/master/addons/docs)
- [Addon: Source](https://github.com/storybookjs/storybook/tree/master/addons/storysource)
- [Addon: Actions](https://github.com/storybookjs/storybook/tree/master/addons/actions)
- [Travis CI](https://travis-ci.com)
## Resources
- [Article: Using ESLint and Prettier in a TypeScript Project](https://www.robertcooper.me/using-eslint-and-prettier-in-a-typescript-project)
- [Template: Rollup Starter Lib (TypeScript)](https://github.com/rollup/rollup-starter-lib/tree/typescript)
- [Article: Creating a React Component library using Rollup, Typescript, Sass and Storybook](https://blog.harveydelaney.com/creating-your-own-react-component-library/)
Explains how to create a React component library using Rollup
- [Template: Debugging tests in VS Code](https://github.com/microsoft/vscode-recipes/tree/master/debugging-jest-tests)