Skip to content

Components for Combat Command, built with React, TypeScript and Base UI.

License

Notifications You must be signed in to change notification settings

ianpaschal/combat-command-components

Repository files navigation

backdrop

Combat Command: Game Systems

A React component library for the Combat Command application.

Installation

npm install @ianpaschal/combat-command-components

Peer Dependencies

This library requires the following peer dependencies:

  • react >= 18.0.0
  • react-dom >= 18.0.0
  • react-router-dom ^7.9.4

Usage

Importing Components

import { AppLogo, AppNavigation, Badge } from '@ianpaschal/combat-command-components';
import '@ianpaschal/combat-command-components/index.css';

Importing Styles

The library provides several style exports:

// Main stylesheet (includes all component styles)
import '@ianpaschal/combat-command-components/index.css';

// CSS variables only
import '@ianpaschal/combat-command-components/styles/variables.css';

// CSS reset only
import '@ianpaschal/combat-command-components/styles/reset.css';

Components

[WIP: See Storybook]

Development

Building

npm run build

Storybook

View components in Storybook:

npm run storybook

Build Storybook for production:

npm run build-storybook

Linting

# TypeScript and ESLint
npm run lint

# SCSS
npm run lint:scss

Generating Type Definitions for SCSS Modules

npm run gen:scss

License

The code in this repository is licensed under the MIT License. See LICENSE for details.

NOTE: Although the code in this repository is licensed under the MIT License, "Combat Command" and associated logos are trademarks of Combat Command and may not be used without permission. The component exists as a means to render the Combat Command logo according to brand guidelines when/where permitted.

About

Components for Combat Command, built with React, TypeScript and Base UI.

Resources

License

Stars

Watchers

Forks

Packages

No packages published