https://github.com/node-projects/custom-sidebar-webcomponent

https://github.com/node-projects/custom-sidebar-webcomponent

Last synced: 9 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/node-projects/custom-sidebar-webcomponent
• Owner: node-projects
• License: mit
• Created: 2024-06-07T06:52:20.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-17T13:39:56.000Z (over 1 year ago)
• Last Synced: 2025-03-15T17:05:04.624Z (10 months ago)
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@node-projects/custom-sidebar-webcomponent
• Size: 365 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# custom-sidebar-webcomponent

[![Published on npm](https://img.shields.io/npm/v/@node-projects/custom-sidebar-webcomponent.svg?logo=npm)](https://www.npmjs.com/package/@node-projects/custom-sidebar-webcomponent)

 

# description

a fully customable sidebar webcomponent...

# modifications

sidebar-width -> Change the width of the sidebar (default = 300px)

sidebar-toggle-button-top-position -> Position of the toggle button depending from top in % (default = 25)

toggle-button-background-color -> Change the backgroundcolor (default = lightgrey)

toggle-button-color -> change color of button icon black or white (default = black)

fully customable while using parts. there are three parts defined to use.

sidebar

toggle-button

slot-element

# development

## upload new version

simple run

  

    npm run release

then you need to go to github and create a release from the uploaded tag.

this will then create a npm package via github action.