Suchi

सूची /sūcī/

a list of things

Blog credit:Evervault

Installation

Install the component from your command line.
pnpm i suchi

Usage

Import all the Suchi components and piece them together.

See how to use each Suchi Component
import Suchi from "suchi

Styling

Suchi comes with some basic styling to quickly setup an article or page. However, you can easily style the Index according to your design.

You can style your Suchi Components by modifying these CSS Variables.

--suchi-accentColor
--suchi-inactive-indicator
--suchi-inactive-item
--suchi-background-color
--suchi-scrollbar-color
Checkout the Styling Guide

Adjustments

On Chrome iOS, the index tray interferes with the app switcher when one scrolls down. To handle this, we increase the bottom padding on the index tray to lift the index items above the appp switcher.

This adjustment is ignored when one scrolls up by clicking on index items.

Accessibility

The Index is accessible by using a hotkey, which is by default CMD + /. Using the

You can change the hotkey using the hotKey prop.