Installation

To install the salmon-ui run the following within your project directory.

npm i @thebigsalmon/salmon-ui

# or

yarn add @thebigsalmon/salmon-ui

Configuration

salmon-ui can be configed in tailwind.config.js:

// tailwind.config.js

module.exports = {
  content: [
    // ...
    "./node_modules/@thebigsalmon/salmon-ui/dist/**/*.{html,js,ts,jsx,tsx}",
  ],
  theme: {
    extend: {},
  },
  variants: {},
  plugins: [require("@tailwindcss/forms")],
};

NOTE: you migth need to install these tailwind plugins to be able to use some particular salmon-ui components:

• @tailwindcss/forms

If you don't use tailwind in your project, you can use pre-build styles from the dist folder:

import "node_modules/@thebigsalmon/salmon-ui/dist/tailwind.css";

Quick start

Here's a quick example to get you started:

import * as React from "react";

import { Button } from "@thebigsalmon/salmon-ui";
​
function App() {
  return (
      <Button label="Hello World!" />
  );
}