malachite-ui

v0.10.1

Published

a year ago

**Malachite UI** is a **component library** inspired by _Tailwind's Headless UI_. Built completely from scratch in _TypeScript_ for **Svelte**, designed to work nicely with CSS Frameworks like **Tailwind CSS** or **WindiCSS**.

Downloads

0High
0Medium
0Low

og_shawn_lee

Malachite UI

Malachite UI is a component library inspired by Tailwind's Headless UI. Built completely from scratch in TypeScript for Svelte, designed to work nicely with CSS Frameworks like Tailwind CSS or WindiCSS.

Malachite UI

Installation

npm install malachite-ui -D

pnpm add malachite-ui -D

Features

Functional: Sit down and relax. Most components will handle all logic and state on their own.
Headless: Build beautiful and unique components, we don't stand in your way.
Reactive: Worry no more, components will react instantly to any prop changes.

Svelte Friendly: All components are handled individually by a single action, meaning you can extract and use them on vanilla DOM elements, this way you have absolute control. You can use Svelte directives like transitions!

<Disclosure let:button let:panel let:close>
  <button use:button>Toggle</button>
  <div slot="panel" use:panel transition:fade>
    <p>Lorem ipsum dolor sit amet consectetur, adipisicing elit.</p>
    <button on:click="{close}">Close Me</button>
  </div>
</Disclosure>

Maximum Styling: No more convoluted classNames. Most components support what I call Object ClassNames and Switch ClassNames (Don't know if other libraries have this but it's cool nonetheless):

<PopoverButton class="{{ base: 'button', open: 'button--open' }}"> Toggle </PopoverButton>
<Tab class="{{ base:'tab', selected: { on: 'tab--selected', off: 'tab-unselected' } }}">
  The Tab
</Tab>
<!-- we support functional classNames too! -->
<PopoverButton class={({ isOpen }) => "button `${isOpen ? 'button--open' : ''}`"}>
  Toggle
</PopoverButton>
<!-- or you can use the Svelte way -->
<Popover let:button let:isOpen>
  <button class="button" button--open="{isOpen}" use:button>Toggle</button>
</Popover>

You can import and use the useClassNameResolver hook and apply it to normal HTML elements if you are using actions:

<script lang="ts">
  import { useClassNameResolver } from 'malachite-ui/hooks';

  let isDarkTheme = false;
  const resolve = useClassNameResolver<'CHECKED' | 'DISABLED'>({
    base: 'switch',
    disabled: 'switch--disabled',
    checked: { on: 'switch--checked', off: 'switch--unchecked' }
  });
</script>

<Switch as="fragment" bind:checked="{isDarkTheme}" let:switcher let:isChecked let:isDisabled>
  <button class="{resolve({ isChecked, isDisabled })}" use:switcher on:click="{toggleDarkTheme}">
    <span class="sr-only"> Toggle Dark Theme </span>
  </button>
</Switch>

This might seem like overkill if you are using simple and short classNames, however if you are using utility CSS frameworks like Tailwind CSS and WindiCSS you will very likely have a substantial amount of classNames, in that case this really comes in handy for better readability.

<AccordionItem let:isOpen let:heading let:panel>
  <h2 use:heading class="h-12">
    <AccordionButton
      class="{{
        base: 'w-full py-2 px-0 | button-reset border-b-blue-50 outline-none transition duration-150 ease-in',
        open: { on: 'font-bold focus:text-soft-violet', off: 'focus:text-soft-red' },
      }}"
    >
      <span class="flex items-center justify-between">
        <span class="text-[13.5px] sm:text-base md:text-lg"> {question} </span>
        <img
          class="transform duration-150 ease-in"
          class:rotate-180="{isOpen}"
          src="{iconArrow}"
          alt=""
        />
      </span>
    </AccordionButton>
  </h2>
  <div slot="panel" use:panel transition:slide="{{ duration: 175, easing: quadOut }}">
    <p class="text-xs sm:text-sm md:text-base">{answer}</p>
  </div>
</AccordionItem>

Components

Accordion

<Accordion let:accordion let:isOpen>
  <AccordionItem let:button let:heading let:panel let:close let:isOpen>
    <AccordionHeader let:heading let:isOpen>
      <AccordionButton class="{{ base: 'button', open:'button--open' }}" let:button let:isOpen>
        First Item
      </AccordionButton>
    </AccordionHeader>
    <AccordionPanel let:panel let:close>
      <p>Lorem ipsum dolor sit amet consectetur, adipisicing elit.</p>
      <button on:click="{close}">Close Me</button>
    </AccordionPanel>
  </AccordionItem>
</Accordion>

Button

<script>
  import { Button } from 'malachite-ui';

  let bold = false;
</script>

<Button bind:pressed={bold}> Turn text Bold </Button>
<span class:font-bold={bold}>
  Lorem ipsum dolor sit amet consectetur adipisicing elit.
</span>

Dialog

<script lang="ts">
  let open = false;
  let ref: HTMLElement;
</script>

<button on:click="{() => open = !open}">Toggle</button>

<dialog bind:open initialFocus="{ref}" let:content let:overlay let:close>
  <DialogContent let:close>
    <DialogOverlay />
    <DialogTitle> Delete Account </DialogTitle>
    <DialogDescription>
      All your data will be permanently deleted. Are you sure about that?
    </DialogDescription>
    <div>
      <button on:click="{nuke}">Go Ahead</button>
      <button bind:this="{ref}" on:click="{close}">Cancel</button>
    </div>
  </DialogContent>
</dialog>

Disclosure

<Disclosure let:button let:panel let:isOpen>
  <DisclosureButton class="{{ base: 'button', open:'button--open' }}" let:button let:isOpen>
    First Item
  </DisclosureButton>
  <DisclosurePanel let:panel let:close>
    <p>Lorem ipsum dolor sit amet consectetur, adipisicing elit.</p>
    <button on:click="{close}">Close Me</button>
  </DisclosurePanel>
</Disclosure>

<menu let:button let:items>
  <MenuButton class="{{ base: 'button', open: 'button--open' }}" let:button let:isOpen>
    Toggle
  </MenuButton>
  <MenuItems let:items>
    <menuitem class="{{ base: 'item', active: 'item--active' }}" let:item let:isActive>
      Edit
    </menuitem>
  </MenuItems>
</menu>

Navigable

<Navigable finite global vertical let:navigable>
  <NavigableItem
    class="{{ base:'item', disabled:{ on:'item--disabled', off:'item--enabled' } }}"
    let:item
  >
    First Item
  </NavigableItem>
  <NavigableItem
    class="{{ base:'item', disabled:{ on:'item--disabled', off:'item--enabled' } }}"
    let:item
  >
    Second Item
  </NavigableItem>
  <NavigableItem
    class="{{ base:'item', disabled:{ on:'item--disabled', off:'item--enabled' } }}"
    let:item
  >
    Third Item
  </NavigableItem>
</Navigable>

Popover

<Popover let:button let:overlay let:panel let:isOpen>
  <PopoverOverlay let:overlay />
  <PopoverButton class="{{ base: 'button', open:'button--open' }}" let:button let:isOpen>
    First Item
  </PopoverButton>
  <PopoverPanel let:panel let:close>
    <p>Lorem ipsum dolor sit amet consectetur, adipisicing elit.</p>
    <button on:click="{close}">Close Me</button>
  </PopoverPanel>
</Popover>

<!-- Popover Group -->

<PopoverGroup let:isOpen>
  <Popover let:button let:overlay let:panel let:isOpen>
    <PopoverOverlay let:overlay />
    <PopoverButton class="{{ base: 'button', open:'button--open' }}" let:button let:isOpen>
      First Item
    </PopoverButton>
    <PopoverPanel let:panel let:close>
      <p>Lorem ipsum dolor sit amet consectetur, adipisicing elit.</p>
      <button on:click="{close}">Close Me</button>
    </PopoverPanel>
  </Popover>
  <Popover let:button let:overlay let:panel let:isOpen>
    <PopoverOverlay let:overlay />
    <PopoverButton class="{{ base: 'button', open:'button--open' }}" let:button let:isOpen>
      First Item
    </PopoverButton>
    <PopoverPanel let:panel let:close>
      <p>Lorem ipsum dolor sit amet consectetur, adipisicing elit.</p>
      <button on:click="{close}">Close Me</button>
    </PopoverPanel>
  </Popover>
</PopoverGroup>

Switch

<label id="label for="switch">Toggle</label>
<Switch checked id="switch" aria-labelledby="label" let:button let:isChecked on:click="{toggle}"/>

<!-- Switch Group -->

<SwitchGroup let:isChecked>
  <SwitchLabel passive let:label let:isChecked> Turn on Notifications </SwitchLabel>
  <SwitchDescription let:description let:isChecked>
    We will send you notifications about our latest products once a week
  </SwitchDescription>
  <Switch class="{{ base: 'switch', checked: 'switch--checked' }}" on:click="{toggle}" />
</SwitchGroup>

Tabs

<TabGroup>
  <TabList let:tablist>
    <Tab class="{{ base: 'tab', selected: 'tab--selected' }}" let:tab let:isSelected>
      First Tab
    </Tab>
  </TabList>
  <TabPanels let:tabpanels>
    <TabPanel let:panel> First Panel </TabPanel>
  </TabPanels>
</TabGroup>

Toast

<script lang="ts">
  import { Toast, ToastGroup, useToast } from 'malachite-ui';

  // add custom fields to your toast object
  interface CustomToast extends ToastObject {
    emoji: string;
  }

  // this is a store; you can create it and access it from anywhere in your app 
  let toast = useToast<CustomToast>(5_000, {
    // a class name for each toast type 
    // access them in your markup with the getToastTypeClassName method
    info: "bg-neutral-800",
    success: "bg-green-800",
    warning: "bg-yellow-800",
    error: "bg-red-800"
  });

  function add() {
    const random = Math.random();
    if (random >= 0.75) {
      toast.push({
        message: 'This is a success toast',
        type: 'success',
        emoji: '🎉'
      });
    } else if (random >= 0.5 && random < 0.75) {
      toast.push({
        message: 'This is an error toast',
        emoji: '😢',
        type: 'error'
      });
    } else if (random >= 0.25 && random < 0.75) {
      toast.push({
        message: 'This is a warning toast',
        emoji: '⚠️',
        type: 'warning'
      });
    } else {
      toast.push({
        message: 'This is an info toast',
        emoji: '📣',
        type: 'info'
      });
    }
  }
</script>

<div>
    <button class="px-6 min-h-10 | bg-transparent border-2 border-neutral-800 rounded-md text-white font-medium outline-none hover:bg-neutral-800 focus:(ring-2 ring-white)" on:click={add}> 
      Add Toast 
    </button>
</div>
<ToastGroup
  class="fixed bottom-6 z-10 right-1/2 transform translate-x-1/2 w-md | grid gap-12px"
  {toast}
>
  {#each $toast as { id, message, emoji, type } (id)}
    <div transition:slide={{ duration: 150 }}>
      <Toast
        class="px-22px py-12px | flex items-center justify-between | {
          toast.getToastTypeClassName(type)
        } rounded-8px"
        {id}
        let:close
      >
        <div class="flex gap-3">
          <p class="text-xl">{emoji}</p>
          <p class="text-lg">{message}</p>
        </div>
        <button class="text-sm bg-transparent" on:click={close}>Close</button>
      </Toast>
    </div>
  {/each}
</ToastGroup>

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme