Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

125 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FeitozaUI

A React and TypeScript UI Engineering Platform focused on foundations, primitives, component APIs, accessibility, testing, documentation, and future package distribution.

TypeScript React Storybook Vitest License: MIT npm

FeitozaUI is not just a set of isolated components. It is being built as a small but professional component platform that documents engineering decisions, public APIs, design foundations, accessibility rules, testing strategy, and package readiness.

Features

  • React and TypeScript-first component APIs.
  • Public package surface with foundational atoms, core molecules, and design tokens.
  • Storybook documentation for foundations, primitives, guidelines, accessibility, and roadmap.
  • Vite library build with ESM, CJS, UMD, and bundled TypeScript declarations.
  • Vitest and Testing Library coverage for public components.
  • Architecture docs, ADRs, component guidelines, release planning, and maintenance docs.

Current Status

FeitozaUI is a work in progress. The current package surface is intentionally small and focused on quality before breadth.

Current:

  • Public components: Button, Box, Flex, Surface, Badge, Divider, Spinner, Skeleton, Progress, Input, Textarea, Select, Alert, EmptyState, Tabs, Card.
  • Foundations: colors, typography, spacing, radii, motion, borders, focus, states, and semantic mappings.
  • Package build validated locally.
  • Storybook structured as the documentation surface.
  • Accessibility and behavior coverage across the active public surface.

Not current:

  • Published npm package.
  • Full theme system.
  • Complete component catalog.
  • BFF, micro-frontends, or production showcase.

Architecture

FeitozaUI is organized around three surfaces:

  • Core library: reusable primitives, tokens, types, and public exports.
  • Storybook: documentation and component exploration.
  • Next app: a future frontend-only showcase surface.

See Architecture and Architecture Decisions.

Package Structure

The future package name is:

@feitoza-ui/core

Current public exports:

export {
  Alert,
  Badge,
  Box,
  Button,
  Card,
  Divider,
  EmptyState,
  Flex,
  Input,
  Progress,
  Select,
  Skeleton,
  Spinner,
  Surface,
  Tabs,
  Textarea
} from '@feitoza-ui/core';

Installation

The package is not published yet. Installation is future work.

Future installation:

npm install @feitoza-ui/core

Quick Start

Run the project locally:

yarn install
yarn.cmd type-check
yarn.cmd lint
yarn.cmd test --run
yarn.cmd storybook

Build the package locally:

yarn.cmd build

Usage

Future package usage:

import { Button, Box, Flex } from '@feitoza-ui/core';

export function AccountSummaryPanel() {
  return (
    <Flex align="center" gap={3}>
      <Box padding={4} radius="medium" bg="backgroundAlt">
        Account summary
      </Box>
      <Button variant="primary">Continue</Button>
    </Flex>
  );
}

Design Tokens

FeitozaUI currently exposes a small token set:

  • semanticColors
  • colors
  • space
  • radii
  • typography
  • fontSizes

The current token model is intentionally simple. Primitive, semantic, and component tokens are documented as future evolution in Foundations.

Core Principles

  • Accessibility by default.
  • TypeScript-first APIs.
  • Predictable component props.
  • Composition over premature abstraction.
  • Documentation as part of delivery.
  • Tests describe behavior.
  • Tokens before repeated hardcoded values.
  • Performance should be measured.

See Core Principles.

Project Structure

.
|-- .storybook/              # Storybook configuration
|-- docs/                    # Project documentation
|-- public/                  # Static assets used by the app/docs
|-- src/
|   |-- app/                 # Next.js app, future showcase surface
|   |-- components/          # Public components under active platform scope
|   |-- design-tokens/       # Token definitions and token docs
|   |-- showcase/            # Storybook-only showcase compositions
|   `-- stories/             # Storybook MDX pages
|-- vite.config.ts           # Library build and Vitest configuration
|-- tsconfig.lib.json        # Type declaration build scope
`-- package.json

Testing

The project uses Vitest and Testing Library.

yarn.cmd test --run

Current tests cover rendering, interactions, disabled behavior, ref forwarding, native prop pass-through, layout props, and basic accessibility expectations for primitives.

See Testing Strategy.

Storybook

Storybook is treated as the project documentation product.

yarn.cmd storybook
yarn.cmd build-storybook

It currently documents Overview, Getting Started, Foundations, Components, Guidelines, Accessibility, and Roadmap.

See Storybook Strategy.

Roadmap

The roadmap is maintained in docs/roadmap/ROADMAP.md.

Short-term focus:

  • Surface primitives and Card 2.0.
  • Documentation and repository polish.
  • Continued accessibility and behavior coverage.
  • Release/versioning workflow before publishing.

Future ideas such as BFF, micro-frontends, monorepo, CLI, and React Native are documented separately in Future Roadmap.

Documentation

Start with the Documentation Index.

Key documents:

Contributing

This is currently a portfolio project, but contribution standards are documented.

See Contributing, Code Style, and Component Checklist.

License

MIT (c) 2026 Maria Fernanda.

About

Projeto em desenvolvimento de design system - feitozaUI

Resources

Contributing

Security policy

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages