Getting started

This page provides instructions on how to get started with Grail UI.

# Installation

Install using your preferred package manager to add to your project:

npm install -D @grail-ui/svelte

# Usage

Our tree-shakeable package includes all of the available functionality, ensuring that all components, actions, and utilities are compatible and kept up-to-date. By using this package, you can selectively include only the dependencies that are required for specific features in your final bundle, reducing the overall size and improving performance. In the below example, only dependencies required for modal and tooltip will be included in your final bundle:

import { createModal, createTooltip } from "@grail-ui/svelte";

If you are unable to use tree shaking, you can still selectively include only the specific modules that you need by importing them directly, like this:

import { createModal } from "@grail-ui/svelte/modal";
import { createTooltip } from "@grail-ui/svelte/tooltip";

# Reading the documentation

Our API documentation for each module includes examples and a live demo that you can edit and experiment with using StackBlitz.

# Need help?

If you have found a bug or have a suggestion for a new feature, you can create an issue on GitHub. Please take a moment to check if the issue has already been reported before submitting a new one.

If you prefer, you can also get in touch with us using any of the following methods to ask questions or get assistance: