# @easyfeedback/navigations

> A collection of default navigations.

Latest version **1.0.6** (published 2021-07-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install @easyfeedback/navigations
pnpm add @easyfeedback/navigations
yarn add @easyfeedback/navigations
bun add @easyfeedback/navigations
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2021-07-05 |
| First published | 2021-06-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 37.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Alexander Böhm |
| Maintainers | mheob |
| Keywords | easyfeedback |

## Links

- npm: https://www.npmjs.com/package/@easyfeedback/navigations
- Repository: https://github.com/easyfeedback/RCL
- Homepage: https://github.com/easyfeedback/RCL/tree/main/packages/navigations#readme
- Issues: https://github.com/easyfeedback/RCL/issues
- npm.io page: https://npm.io/package/@easyfeedback/navigations

## Dependencies (2)

- [react-icons](https://npm.io/package/react-icons.md) ^4.2.0
- [@easyfeedback/buttons](https://npm.io/package/@easyfeedback/buttons.md) ^1.3.0

## Recent versions

- 1.0.6 (latest) — 2021-07-05
- 1.0.5 — 2021-06-21
- 1.0.4 — 2021-06-21
- 1.0.3 — 2021-06-18
- 1.0.2 — 2021-06-18
- 1.0.1 — 2021-06-17
- 1.0.0 — 2021-06-16

## README

# Navigations

## Table of Contents <!-- omit in toc -->

- [Installation](#installation)
- [FolderNavigation](#foldernavigation)

## Installation

```sh
yarn add @easyfeedback/navigations
# or
npm i @easyfeedback/navigations
```

## FolderNavigation

`FolderNavigation` is a side navigation for the folder overview.

At the very top there is a button for creating a new folder. This is followed by all folders to
which the current user has access to.

### Import component

```tsx
import { FolderNavigation } from '@easyfeedback/navigations'
```

### General usage

```tsx
const myFolderList = [
  { id: '1', numberOfItems: 10, title: 'My Surveys', href: '#' },
  { id: '2', numberOfItems: 3, title: 'Marketing', href: '#' },
]

<FolderNavigation folderList={myFolderList} />
```

### Props

| Name              | Description                                                                                              | type                                                        | Default |
| ----------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | ------- |
| myFolderList      | The list with all the folders the user has access to.                                                    | `Folder[]`                                                  | -       |
| onCreateNewFolder | _[Optional]_ The function with the information what happens when the button "Add new folder" is clicked. | `MouseEventHandler<HTMLButtonElement \| HTMLAnchorElement>` | -       |
| onEditSettings    | _[Optional]_ The function with the information what happens when the button "Settings" is clicked.       | `MouseEventHandler<HTMLButtonElement>`                      | -       |
| onDeleteFolder    | _[Optional]_ The function with the information what happens when the button "Delete" is clicked.         | `MouseEventHandler<HTMLButtonElement>`                      | -       |

---
_Source: https://npm.io/package/@easyfeedback/navigations · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
