Common front-end components for Web using the Tesseract design system, written for React. https://make.modal.sh/tesseract/web/react/common
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
TheoryOfNekomata 1ba89be19e Add name 3 years ago
packages Add name 3 years ago
plop/templates Update directory structure, generator code 3 years ago
utilities Initial commit 4 years ago
.editorconfig Initial commit 4 years ago
.env.example Add example env file 4 years ago
.gitignore Improve navigation on mobile 3 years ago
.npmignore Update ignores 3 years ago
.prettierrc Improve test coverage 4 years ago
LICENSE Add README, LICENSE 4 years ago
README.md Add value props, fix styling of docs page 3 years ago
global.d.ts Initial commit 4 years ago
jest.config.js Add Next.js + MDX support 3 years ago
jest.setup.ts Initial commit 4 years ago
package.json Add value props, fix styling of docs page 3 years ago
plopfile.js Update directory structure, generator code 3 years ago
rollup.config.js Update directory structure, generator code 3 years ago
tsconfig.json Update ignores 3 years ago
yarn.lock Update docs 3 years ago

README.md

Tesseract Design - React Common

Common front-end components for Web using the Tesseract design system, written for React.

Package:

@tesseract-design/react-common Version List

Dependencies:

React Styled Components TypeScript Jest Rollup

Check the documentation for more details.

Installation

This package resides primarily in the Modal.sh JavaScript Package Registry. You will need to adjust configuration in your chosen package manager.

With Yarn v.1.x, add this to your .yarnrc file:

"@tesseract-design:registry" "https://js.pack.modal.sh/"

Then, install the package by running the following command:

yarn add @tesseract-design/react-common

Usage

The package includes components as named exports. Simply import the components you need individually or use a namespace import, like so:

import * as React from 'react'
import ReactDOM from 'react-dom'
import * as T from '@tesseract-design/react-common'

const LoginForm = etcProps => (
  <form
    {...etcProps}
  >
    <fieldset>
      <legend>
        Log In
      </legend>
      <div>
        <T.TextInput
          label="Username"
        />
      </div>
      <div>
        <T.TextInput
          type="password"
          label="Password"
        />
      </div>
      <div>
        <T.Button>
          Log In
        </T.Button>
      </div>
    </fieldset>
  </form>
)

const mountNode = window.document.createElement('div')

ReactDOM.render(
  <LoginForm />,
  mountNode,
)

window.document.body.appendChild(mountNode)

Detailed usage guides can be found in the documentation linked above.

TypeScript

The package is written and tested using TypeScript. Thus, typings for consumption in TypeScript are bundled with the compiled source.

License

MIT. See the LICENSE file on the package repository for the full text.