custom-sidebar - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #go #deep-learning #nodejs #macos #windows #awesome #kubernetes #vue #pytorch #ios #openai #open-source

custom-sidebar

(★ 290)

Custom HACS plugin that allows you to personalise the Home Assistant's sidebar per user or device basis

File Explorer

Download Latest Version (.zip)

- - bug_report.md
- - build.yaml
  - docs.yaml
  - ha-beta-tests.yaml
  - hacs.yaml
  - tests.yaml
- dependabot.yml
- FUNDING.yml
- - .HA_VERSION
  - automations.yaml
  - configuration.yaml
  - home-assistant.log
  - home-assistant.log.1
  - home-assistant.log.fault
  - home-assistant_v2.db
  - home-assistant_v2.db-shm
  - home-assistant_v2.db-wal
  - scenes.yaml
  - scripts.yaml
  - secrets.yaml
  - ui-lovelace.yaml
- custom-sidebar-plugin.js
- custom-sidebar.js
- - authors.yml
- - 01-intro.mdx
  - 02-installation.mdx
  - 06-home-assistant-built-in-sidebar-configuration-options.mdx
  - 07-custom-sidebar-extras.mdx
- - .nojekyll
- - dark.ts
  - light.ts
- .gitignore
- docusaurus.config.ts
- package.json
- pnpm-lock.yaml
- pnpm-workspace.yaml
- README.md
- sidebars.ts
- tsconfig.json
- default-sidebar.png
- new-items.png
- personalise.png
- reorder-items.png
- - global.ts
  - index.ts
- - index.ts
- - index.ts
- - index.ts
- - index.ts
- - index.ts
- - index.ts
- checker.ts
- custom-sidebar.ts
- 01 - elements-properties.spec.ts
- 02 - basic-options.spec.ts
- 03 - basic-options-hover.spec.ts
- 04 - item-color-options-overriding.spec.ts
- 05 - item-color-options-extending.spec.ts
- 06 - sidebar-mode.spec.ts
- 07 - exceptions-options.spec.ts
- 08 - extendable-configs.spec.ts
- 09 - javascript-templates.spec.ts
- 10 - javascript-templates-methods.spec.ts
- 11 - javascript-templates-returns.spec.ts
- 12 - jinja-templates.spec.ts
- 13 - interactions.spec.ts
- 14 - edge-cases.spec.ts
- 15 - fetch-config-errors.spec.ts
- 16 - validator-errors.spec.ts
- 17 - with-scrollbars.spec.ts
- 18 - debug-analytics.spec.ts
- constants.ts
- ha-services.ts
- selectors.ts
- utilities.ts
.gitignore
CODE_OF_CONDUCT.md
custom-sidebar-config.yaml
eslint.config.mjs
hacs.json
LICENSE
package.json
playwright.config.ts
pnpm-lock.yaml
pnpm-workspace.yaml
README.md
rollup.config.mjs
tsconfig.json

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Custom Sidebar

[![hacs_badge](https://img.shields.io/badge/HACS-Default-41BDF5.svg)](https://github.com/hacs/integration)
[![HACS Action](https://github.com/elchininet/custom-sidebar/actions/workflows/hacs.yaml/badge.svg)](https://github.com/elchininet/custom-sidebar/actions/workflows/hacs.yaml)
[![Tests](https://github.com/elchininet/custom-sidebar/actions/workflows/tests.yaml/badge.svg)](https://github.com/elchininet/custom-sidebar/actions/workflows/tests.yaml)
[![Coverage Status](https://coveralls.io/repos/github/elchininet/custom-sidebar/badge.svg?branch=master)](https://coveralls.io/github/elchininet/custom-sidebar?branch=master)
[![downloads](https://img.shields.io/github/downloads/elchininet/custom-sidebar/total)](https://github.com/elchininet/custom-sidebar/releases)

[![Home Assistant Nightly Beta Tests](https://github.com/elchininet/custom-sidebar/actions/workflows/ha-beta-tests.yaml/badge.svg)](https://github.com/elchininet/custom-sidebar/actions/workflows/ha-beta-tests.yaml)

Custom [HACS] plugin that allows you to personalise the [Home Assistant]'s sidebar per user or device basis

<table>
  <thead>
    <tr>
      <th width="25%">Default sidebar</th>
      <th width="25%">Hide/add some items</th>
      <th width="25%">Reorder items</th>
      <th width="25%">Personalise</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td colspan="4">
      </td>
    </tr>
    <tr>
      <td>
        &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br><img src="https://raw.githubusercontent.com/elchininet/custom-sidebar/master/images/default-sidebar.png" alt="default sidebar" /><br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
      </td>
      <td>
        &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br><img src="https://raw.githubusercontent.com/elchininet/custom-sidebar/master/images/new-items.png" alt="hide and new items" /><br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
      </td>
      <td>
        &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br><img src="https://raw.githubusercontent.com/elchininet/custom-sidebar/master/images/reorder-items.png" alt="reorder items" /><br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
      </td>
      <td>
        &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br><img src="https://raw.githubusercontent.com/elchininet/custom-sidebar/master/images/personalise.png" alt="personalise" /><br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
      </td>
    </tr>
  </tbody>
</table>

This is a refactor of [custom-sidebar-v2] by @galloween, which unfortunately is now unmaintained and archived. In its beginning, @galloween's code was a refactor of the [original Custom Sidebar] plugin by @Villhellm. This version refactored completely @galloween's code, fixing several bugs, improving performance, adding a huge amount of options to configure the sidebar and using [home-assistant-query-selector] to make it less likely to break with future Home Assistant front-end updates.

## Installation and Configuration instructions

Consult the [Custom Sidebar Docs]

---

### Credits and huge thanks to:

* [Villhellm](https://github.com/Villhellm) | Original creator of custom-sidebar (R.I.P.).
* [galloween](https://github.com/galloween) | forked the original `custom-sidebar` and maintained it for a while

[HACS]: https://hacs.xyz
[Home Assistant]: https://www.home-assistant.io
[custom-sidebar-v2]: https://github.com/galloween/custom-sidebar-v2
[original Custom Sidebar]: https://github.com/Villhellm/custom-sidebar
[home-assistant-query-selector]: https://github.com/elchininet/home-assistant-query-selector
[Custom Sidebar Docs]: https://elchininet.github.io/custom-sidebar/