Skip to content

joelvoss/react-lit-disclosure

Repository files navigation

@react-lit/disclosure

A disclosure is a button that controls visibility of a section of content. When the controlled content is hidden, it is often styled as a typical push button with a right-pointing arrow or triangle to hint that activating the button will display additional content. When the content is visible, the arrow or triangle typically points down.

Installation

$ npm i @react-lit/disclosure
# or
$ yarn add @react-lit/disclosure

Example

import * as React from 'react';
import { Disclosure, DisclosureButton, DisclosurePanel } from "@react-lit/disclosure";

function Example() {
  return (
    <Disclosure>
      <DisclosureButton>Expand me!</DisclosureButton>
      <DisclosurePanel>
        Li Europan lingues es membres del sam familie.
        Lor separat existentie es un myth. Por scientie, musica, sport etc,
        litot Europa usa li sam vocabular.
      </DisclosurePanel>
    </Disclosure>
  );
}

Development

(1) Install dependencies

$ npm i
# or
$ yarn

(2) Run initial validation

$ ./Taskfile.sh validate

(3) Run tests in watch-mode to validate functionality.

$ ./Taskfile test -w

This project was set up by @jvdx/core

About

A disclosure is a button that controls visibility of a section of content.

Resources

License

Stars

Watchers

Forks