react-drilld

The best DrillDown for folder or graph or tree structure package for react

What is this?

This package is a React component that can display graphic, tree or folder structures as a drill-down technique. You can call the data simply or using the api and display it to the users. Users can now easily analyze unstructured data that is difficult to understand and select their items in an analyzed and comprehensible way.

Table of Contents

• Installation
• Usage
• Example
  • Simple
  • Advance
  • more Advance
• Demo
• Documentation
• Creator
• License

Installation

You can install this package in two ways simultaneously

install with npm

npm install react-drilld

install with yarn

yarn add react-drilld

Usage

import {DrillD} from 'react-drilld';

or

import DrillD from 'react-drilld';

Examples

Simple

simple example for show simple folder structure data

import React, { Component } from 'react';
import {DrillD} from 'react-drilld';

function App() {
  return (
    <div className="App">
      <DrillD
        title="Choose Folder or File"
        folders={[
          {
            name: 'Folder A',
            children: [{name: 'File A1'}, {name: 'File A2'}, {name: 'Folder AA', children: [{name: 'File AA1'}]}]
          },
          {
            name: 'File 1'
          },
          {
            name: 'Folder B',
            children: [{name: 'File B1'}, {name: 'File A2'}, {name: 'Folder BB', children: [{name: 'File BB1'}]}]
          },
        ]}
      />
    </div>
  );
}

Advance

advance example for show folder structure data with fetch from url

import React, { Component } from 'react';
import {DrillD} from 'react-drilld';

function App() {
  return (
    <DrillD
      title="Choose Category"
      url="https://api.stlouisfed.org/fred/category/children"
      mode="multiple"
      showFullPath
      isSelectableFolder
      queryParams={{api_key: 'f8d2c84d4b22cefd6a6e1d5e78128c61', file_type: 'json'}}
      selectFolderQueryParams={(folder: any) => ({category_id: folder?.id})}
      fetchedChildrenDataPath={['categories']}
      folderKey
    />
  );
}

more Advance

more advance example for show folder structure data with fetch from dynamic url for every depth

import React, { Component } from 'react';
import {DrillD} from 'react-drilld';

function App() {
  return (
    <DrillD
      title="Choose city"
      url={[
        'https://api.countrystatecity.in/v1/countries',
        'https://api.countrystatecity.in/v1/countries/{{0.iso2}}/states',
        'https://api.countrystatecity.in/v1/countries/{{0.iso2}}/states/{{1.iso2}}/cities'
      ]}
      maxDepth={2}
      headerRequest={{
        'X-CSCAPI-KEY': 'WG10bkduU1owaVJDQ0I2bGt6VG9pREtoNkZuY2ZlR2Jna1lRVWFPcw=='
      }}
      mode="multiple"
      folderKey
      hasSearch
    />
  );
}

Demo

A demo is worth a thousand words

Documentation

Check the documentation to get you started!

Creator

Sina Shah Oveisi @sinashahoveisi

I love programming and I am interested in popular frameworks or programming languages and I am currently coding with JavaScript and React framework.

License

MIT © Sina Shahoveisi