Bedrock UI

Bedrock UI is a TypeScript-based component library offering UI sharable components for Bedrock.

Key Features

• TypeScript Support: Full TypeScript integration ensures enhanced code quality and developer experience.
• Reusable Components using shad-cn: A set of components adopted from shad-cn designed for reuse across different parts of your application.
• Tailwind CSS Integration: Styling with Tailwind CSS for a utility-first approach.
• Storybook Documentation: Components are documented in Storybook, making it easy to visualize and interact with them during development.

Available Components

Bedrock UI includes the following key components:

• Footer: A customizable footer component for application layouts.
• Header: A versatile header component suitable for various application needs.
• StartButton (alias of TokenListDropdown): A dropdown component, primarily used as a start button in applications.
• TokenListDropdown: A dropdown component for listing and selecting tokens.
• shareableConstants: A collection of constants that can be used across different components.

Project Structure

• /src: Contains the source code with components, utilities, and types.
• /stories: Storybook files showcasing how to use the components.

Installation

npm install bedrock-ui
# or
yarn add bedrock-ui

Usage

Import and use the Bedrock UI components in your React application:

import { Header, Footer } from 'bedrock-ui';

function App({ children }) {
  return (
    <>
      <Header />
      {children}
      <Footer />
    </>
  );
}

Running Storybook

To explore components in Storybook:

npm run storybook
# or
yarn storybook

Contributing

Contributions to Bedrock UI are welcome. Please adhere to the project's contribution guidelines when submitting patches or features.

License

Bedrock UI is licensed under the MIT License.