Skip to content

software-mansion-labs/t-rex-ui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

T-Rex UI header image

T-Rex UI is a React component library that contains of reusable Docusaurus theme components. It aims to unify the components across SWM documentations.

Installation

Install the package in your project directory with:

npm install @swmansion/t-rex-ui

Usage

To use components in your project you need to simply import them from the package in appriopriate folder, just as in example below:

PaginatorNavLink/index.js

import { PaginatorNavLink } from '@swmansion/t-rex-ui';
export default PaginatorNavLink;

Available theme components

For now following components are available:

  • Admonition
  • ColorModeToggle
  • DocCard
  • DocItem
  • DocSidebar
  • DocSidebarItem
  • DocSidebarItems
  • Logo
  • PaginatorNavLink
  • ThemedImage
  • TOCCollapsible
  • TOCItems (including TOCItems and TOCItemTree)

About

React component library for Software Mansion's Docusaurus themes 🦖

Resources

License

Stars

Watchers

Forks