https://github.com/svar-widgets/toolbar
Svelte toolbar component. Lightweight, customizable, easy-to-use.
https://github.com/svar-widgets/toolbar
svelte svelte-component svelte-ui-components sveltejs toolbar toolbar-button ui-component
Last synced: 8 months ago
JSON representation
Svelte toolbar component. Lightweight, customizable, easy-to-use.
- Host: GitHub
- URL: https://github.com/svar-widgets/toolbar
- Owner: svar-widgets
- License: mit
- Created: 2024-10-04T17:56:44.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-21T09:54:58.000Z (9 months ago)
- Last Synced: 2025-04-17T19:19:13.200Z (8 months ago)
- Topics: svelte, svelte-component, svelte-ui-components, sveltejs, toolbar, toolbar-button, ui-component
- Language: Svelte
- Homepage:
- Size: 337 KB
- Stars: 18
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license.txt
Awesome Lists containing this project
README
# SVAR Svelte Toolbar
[](https://www.npmjs.com/package/wx-svelte-toolbar)
[](https://github.com/svar-widgets/toolbar/blob/main/license.txt)
[](https://www.npmjs.com/package/wx-svelte-toolbar)
[Documentation](https://docs.svar.dev/svelte/core/toolbar/) • [Demos](https://docs.svar.dev/svelte/core/samples-toolbar/#/base/willow)
A Svelte UI component for building flexible button panels, from simple button sets to complex structures with numerous buttons and select boxes. It provides an easy way to organize and display multiple toolbar items, with support for multiline layouts and collapsible item groups that can be shown on demand.
### How to Use
To use the widget, simply import the package and include the component in your Svelte file:
```svelte
import { Toolbar } from "wx-svelte-toolbar";
function onClick(item) {
message = "Button '" + item.id + "' clicked";
}
let items = [
{ id: "label", text: "Toolbar with icon buttons" },
{
id: "search",
comp: "button",
icon: "wxi-search",
handler: onClick,
},
];
```
### Svelte 4 and Svelte 5 versions
There are two versions of the library: the 1.x version, designed to work with Svelte 4, and the 2.x version, created for Svelte 5. Please note that the 2.x version is in beta and may contain some instabilities.
To use the SVAR Toolbar beta for Svelte 5, install it as follows:
```
npm install wx-svelte-toolbar
```
To use the SVAR Toolbar for Svelte 4:
```
npm install wx-svelte-toolbar@1.3.0
```
### How to Modify
Typically, you don't need to modify the code. However, if you wish to do so, follow these steps:
1. Run `yarn` to install dependencies. Note that this project is a monorepo using `yarn` workspaces, so npm will not work
2. Start the project in development mode with `yarn start`
### Run Tests
To run the test:
1. Start the test examples with:
```sh
yarn start:tests
```
2. In a separate console, run the end-to-end tests with:
```sh
yarn test:cypress
```