# menu-system

> Creates flexible tree of routing items

Latest version **0.1.3** (published 2019-08-20) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install menu-system
pnpm add menu-system
yarn add menu-system
bun add menu-system
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2019-08-20 |
| First published | 2018-10-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 37.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | mc-petry |
| Maintainers | mc-petry |
| Keywords | menu, tree, router |

## Links

- npm: https://www.npmjs.com/package/menu-system
- Repository: https://github.com/mc-petry/menu-system
- Homepage: https://github.com/mc-petry/menu-system#readme
- Issues: https://github.com/mc-petry/menu-system/issues
- npm.io page: https://npm.io/package/menu-system

## Alternatives

- [express-promise-router](https://npm.io/package/express-promise-router.md) — 736.1K weekly downloads
- [next-usequerystate](https://npm.io/package/next-usequerystate.md) — 29.8K weekly downloads
- [@bitkyc08/opencodex](https://npm.io/package/@bitkyc08/opencodex.md) — 4.6K weekly downloads
- [lynkr](https://npm.io/package/lynkr.md) — 575 weekly downloads
- [baremetal.js](https://npm.io/package/baremetal.js.md) — 42 weekly downloads

## Recent versions

- 0.1.3 (latest) — 2019-08-20
- 0.1.1 — 2018-10-16
- 0.1.0 — 2018-10-01

## README

# menu-system

Powerful and simple tool to build a complex menu tree.

# Usage

Construct menu:

```ts
// Create builder
const builder = createMenuBuilder(options?: MenuConfig)

// Create tree
const tree = builder.tree(({ route, arg }) => ({
  home: route(),
  users: route({
    children: {
      id: arg({
        children: {
          comments: route()
        }
      })
    }
  })
}))

// Build tree
const menu = builder.build(tree)
```

Use it anywhere:

```ts
menu.routes.home._.fullpath() // '/home'
menu.routes.users.id._.fullpath({ id: '1' }) // '/users/1'
menu.routes.users.id.comments._.fullpath({ id: 'mc-petry' }) // '/users/mc-petry/comments'
```

## Configuration

```ts
interface MenuConfig {
  /**
   * Global routes prefix.
   * @default '/'
   */
  basePath?: string

  /**
   * Use trailing slash on routes
   * @default false
   */
  trailingSlash?: boolean
}
```

## Helpers

```ts
/**
 * Returns route that match specified location.
 * Otherwise returns null
 */
menu.findRoute(location: string, maxLevel?: number): Route | null
```

## Routes meta

```ts
const menu = builder.build(
  builder.tree(({ route }) => ({
    home: route({
      meta: {
        hidden: true
      }
    }),
    about: route({
      meta: {
        hidden: false
      }
    })
  }))
)

// Example usage
menu.routes._.children.filter(route => !route.meta.hidden)
```

## Split trees

```ts
const homeTree = builder.tree(...)
const usersTree = builder.tree(...)

const menu = builder.build({
  ...homeTree,
  ...usersTree
})
```

# Compatibility

All modern environments.\
IE 11 requires polyfills: `String.startsWith()`

# Development

## Publishing

`npm run build`\
`npm publish dist`

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