Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/knovator/data-import-widget
Widget built to communicate easily with `@knovator/data-import` application.
https://github.com/knovator/data-import-widget
data-import database excel-import spreadsheet widget
Last synced: 28 days ago
JSON representation
Widget built to communicate easily with `@knovator/data-import` application.
- Host: GitHub
- URL: https://github.com/knovator/data-import-widget
- Owner: knovator
- License: mit
- Created: 2022-01-06T04:38:36.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-03T09:43:51.000Z (over 2 years ago)
- Last Synced: 2023-03-09T03:51:43.969Z (almost 2 years ago)
- Topics: data-import, database, excel-import, spreadsheet, widget
- Language: TypeScript
- Homepage:
- Size: 821 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
  
@knovator/data-import-widget
`@knovator/data-import-widget` is built to communicate easily with `@knovator/data-import` application.
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
## About The Project
It provides user side of part for already generated templates and allow user to import data into their database system. For more info about backend application, please visit [knovator/data-import](https://github.com/knovator/data-import).
### Built With
* [ReactJS](https://reactjs.org/)
* [TailwindCSS](https://tailwindcss.com/)
* [Typescript](https://www.typescriptlang.org/)
* [Babel](https://babeljs.io/)
## Getting Started
To use `data-import-widget` in your application you need ReactJS or NextJS application ready.
### Prerequisites
- Create empty react application if not have already.
```sh
npx create-react-app my-app
cd my-app
npm start
```
- Your [Data Import](https://github.com/knovator/data-import) project should be running and also there should be atleast one template to get started.
### Installation
1. Install **Data Import Widget**, by running following command inside your applicaiton.
```
npm i @knovator/data-import-widget
```
## Usage
- Using `data-import-widget` is easy to use, it listens to click event on it's children and based on that it will open modal for importing files.
```jsx
import DataImport from '@knovator/data-import-widget'
function App() {
return (
Import data
)
}
```
- Here it will load templates from your provided project. Once you choose a template it will show the option to upload the file(`.xlsx`, `.csv`).
- After uploading a file via the Import button, the Import Data modal will be closed. In the background, it will do validation and transformation based on columns of the selected template.
- After all that, it will call the callback URL from the template with extracted data.
- Loading thousands of data at one time is not good for the server, it'll unnecessarily use CPU and Memory. To reduce such kind of accident it will split data into chunks of 1000 and then it will call a callback API.
| Props | Required ? | Type | Use Case |
| ------------------- | ---------- | ---------- | ------------------------------------------------------------ |
| `onNotify` | false | `function` | `{type: 'success' | 'error',payload: success message or error stack}` |
| `getAdditionalInfo` | false | `function` | it can be used if you need to pass addition data to the proccess file |
| `projectCode` | true | `string` | You need to pass your project code to load templates. |
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
## Contact
Knovator Technologies
- Twitter [@knovator](https://twitter.com/knovator)
- Web [https://knovator.com/](https://knovator.com/)
Project Link: [https://github.com/knovator/data-import-widget](https://github.com/knovator/data-import-widget)