Skip to content

Svelte toolbar component. Lightweight, customizable, easy-to-use.

License

Notifications You must be signed in to change notification settings

svar-widgets/toolbar

Repository files navigation

SVAR Svelte Toolbar

npm License npm downloads

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.

Versions for Svelte 4 and 5

There are two versions of the Toolbar component:

  • version 1.x was designed to work with Svelte 4
  • version 2.x is created for Svelte 5 (please note that this version is in beta and may contain some instabilities)

To use SVAR Toolbar v.2.0 beta for Svelte 5, install it as follows:

npm install wx-svelte-toolbar

To use SVAR Toolbar for Svelte 4:

npm install [email protected]

How to Use

To use the widget, simply import the package and include the component in your Svelte file:

<script>
	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,
		},
	];
</script>

<Toolbar {items} />

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:
    yarn start:tests
  2. In a separate console, run the end-to-end tests with:
    yarn test:cypress