> For the complete documentation index, see [llms.txt](https://ignitus-docs.gitbook.io/side-navigation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ignitus-docs.gitbook.io/side-navigation/master.md).

# About

A side navigation package we make use at @ignitus-DesignSystem.

Easy, responsive & flexible **navigational component** that compose declaratively with your application.

`<SideNavigation>` is fully customisable with lot of capabilities being offered as of now.&#x20;

We are still in a phase of improving it with passage of time, if you are interested in contributing to the project please go through our [contribution guidelines](https://ignitus-docs.gitbook.io/side-navigation/overview/contribution).

Its is written in TypeScript => The package can be used both for Typescript and Javascript users. 🎯

The only downside as of now is component is written using [**emotion**](https://emotion.sh/docs/introduction) (css-in-js) as its [**peerDependency**](https://nodejs.org/es/blog/npm/peer-dependencies/) once you install the package you will get a warning like this from NPM.

```bash
npm WARN side-navigation-react@1.0.1 requires a peer of @emotion/core@^10.0.22 but none is installed. You must install peer dependencies yourself.
npm WARN side-navigation-react@1.0.1 requires a peer of @emotion/styled@^10.0.23 but none is installed. You must install peer dependencies yourself.
npm WARN side-navigation-react@1.0.1 requires a peer of react-router-dom@^5.1.2 but none is installed. You must install peer dependencies yourself.
npm WARN side-navigation-react@1.0.1 requires a peer of @emotion/is-prop-valid@^0.8.8 but none is installed. You must install peer dependencies yourself.
```

If you are already using [**emotion**](https://emotion.sh/docs/introduction) (css-in-js) as one of your dependency you are good to go. 🍻.

{% hint style="info" %}
If you want to play with the live component please head over to the next page. 🚀
{% endhint %}
