https://github.com/nteract/directory-listing
A set of React components for creating directory list views in nteract-based applications
https://github.com/nteract/directory-listing
Last synced: about 2 months ago
JSON representation
A set of React components for creating directory list views in nteract-based applications
- Host: GitHub
- URL: https://github.com/nteract/directory-listing
- Owner: nteract
- License: bsd-3-clause
- Created: 2020-03-11T22:02:37.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-01T17:29:29.000Z (over 2 years ago)
- Last Synced: 2025-03-30T21:02:20.583Z (2 months ago)
- Language: TypeScript
- Size: 719 KB
- Stars: 3
- Watchers: 1
- Forks: 3
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @nteract/directory-listing
This package contains components that can be used to create a listing of items within a directory. To see this package in action, you can view the source code for the [nteract commuter application](https://github.com/nteract/commuter).
## Installation
```
$ yarn add @nteract/directory-listing
```
```
$ npm install --save @nteract/directory-listing
```
## Usage
The example below shows how we can use the components within this package to create a listing of the items in a directory.
```javascript
import { Listing, Entry, Icon, Name, LastSaved } from "@nteract/directory-listing";
export function () =>
GANS-for-days.ipynb
component.js
no-permission-file.md
```
## Documentation
You can view the reference documentation for `@nteract/directory-listing` in the Markdown files within the `src` directory.
## Support
If you experience an issue while using this package or have a feature request, please file an issue on the [issue board](https://github.com/nteract/directory-listing/issues).
## License
[BSD-3-Clause](https://choosealicense.com/licenses/bsd-3-clause/)