**A Vue 3 component to display hierarchical data (like the MacOS X finder)**
[](https://travis-ci.org/jledentu/vue-finder)
[](https://www.npmjs.com/package/@jledentu/vue-finder)
[](https://codecov.io/gh/jledentu/vue-finder)
[](https://www.codefactor.io/repository/github/jledentu/vue-finder/overview/master)
[](https://github.com/semantic-release/semantic-release)
## Documentation
The documentation is available on the [website](https://vue-finder.netlify.app/).
## Getting Started
```sh
npm install --save @jledentu/vue-finder
```
An example of Vue Single File component:
```html
```
### Browser
You can also include the standalone UMD build in your page from the jsdeliver CDN. Make sure to import Vue as a dependency before vue-finder.
```html
```
## Changelog
See the GitHub [release history](https://github.com/jledentu/vue-finder/releases).
## Contributing
Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.
### Development scripts
- `yarn build` to build the library
- `yarn test` to run the unit tests
- `yarn storybook` to run the [Storybook](https://github.com/storybookjs/storybook) in watch mode
- `yarn docs:dev` to run the [Vuepress](https://github.com/vuejs/vuepress) documentation in watch mode
## Credits
- [Lodash](https://lodash.com/) for some utility functions
- [Vue-treeselect](https://vue-treeselect.js.org/), [Vue-data-tables](https://www.njleonzhang.com/vue-data-tables) and [Vue-multiselect](https://vue-multiselect.js.org) as inspiration for naming and documentation
## License
[MIT](https://choosealicense.com/licenses/mit/)