npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-dsv-import

v0.4.10

Published

Flexible, typed and easy to use React Component ⚛ to provide CSV, TSV and other delimiter-separated values formats (DSV) import functionality.

Downloads

510

Readme

react-dsv-import

Flexible, typed and easy to use React Component ⚛ to provide CSV, TSV and other delimiter-separated values formats (DSV) import functionality.

npm npm peer dependency version GitHub

Demonstration

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
  • pnpm: pnpm add react-dsv-import

TypeScript

import { DSVImport, ColumnsType } from 'react-dsv-import';

type BasicType = { forename: string; surname: string; email: string };

const columns: ColumnsType<BasicType> = [
  { key: 'forename', label: 'Forename' },
  { key: 'surname', label: 'Surname' },
  { key: 'email', label: 'Email' }
];

<DSVImport<BasicType> columns={columns}>
  <DSVImport.TextareaInput />
  <DSVImport.TablePreview />
</DSVImport>

JavaScript

import { DSVImport } from 'react-dsv-import';

const columns = [
  { key: 'forename', label: 'Forename' },
  { key: 'surname', label: 'Surname' },
  { key: 'email', label: 'Email' }
];

<DSVImport columns={columns}>
  <DSVImport.TextareaInput />
  <DSVImport.TablePreview />
</DSVImport>

API

The <DSVImport<T>> components has the following API:

| Property | Type | Description | | :-------------- | :------------------------------ | :------------------------------------------------------ | | columns | ColumnType | Description of the expected columns | | transformers? | Transformer[] | Globally applied transformers | | onChange? | (value: T[]) => void | Callback which is called after parsing the input | | onValidation? | (errors: Error<T>[]) => 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[] | Validation rules which are applied to this column | | transformers? | Transformer[] | Transformers which are applied to this column |

Rule

| Property | Type | Description | | :---------- | :------------------------------------------------------------------ | :----------------------- | | message | string | Error message | | contraint | { unique: boolean } \| { 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 integration (see storybook)
  • ✅ Input transformation (e.g. trim, ...)
  • Material UI integration (see storybook)

✅ means the feature is implemented and released. ❌ indicates that a feature is planned.