@feitoza-ui/core
v0.3.0
Published
React and TypeScript UI Engineering Platform focused on foundations, primitives, accessibility, testing, and documentation.
Downloads
24
Maintainers
Readme
FeitozaUI
A compact React and TypeScript component library focused on foundations, accessible APIs, testing, documentation, and verified package distribution.
FeitozaUI is a deliberately small component platform for practical React interfaces. It documents public APIs, design foundations, accessibility rules, testing strategy, and package-readiness decisions rather than growing an unbounded component catalog.
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 verified 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 V1 is intentionally compact and focused on quality before breadth. The package is ready for a manual first release, but is not published to npm yet.
Current:
- Editorial V1 catalog:
Button,Checkbox,Radio,RadioGroup,Input,Textarea,Select,Tabs,Surface, andCard. - Supporting public primitives:
Badge,Box,Divider,EmptyState,Field,Flex,IconButton,Progress,Skeleton,Spinner, andVisuallyHidden. - Foundations: colors, typography, spacing, radii, motion, borders, focus, states, and semantic mappings.
- Package artifacts verified through local tarball consumers for React + Vite and Next.js App Router.
- Storybook structured as the documentation surface.
- Accessibility and behavior coverage across the active public surface.
Not current:
- Published npm package (manual publication is the remaining external release action).
- 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/coreThe V1 editorial catalog is documented in V1 Scope. Current public exports include:
export {
Alert,
Badge,
Box,
Button,
Card,
Checkbox,
Divider,
EmptyState,
Field,
Flex,
IconButton,
Input,
Progress,
Radio,
RadioGroup,
Select,
Skeleton,
Spinner,
Surface,
Tabs,
Textarea,
VisuallyHidden
} from '@feitoza-ui/core';Installation
The package is not published yet. After the first manual publish:
npm install @feitoza-ui/coreQuick Start
Run the project locally:
yarn install
yarn.cmd type-check
yarn.cmd lint
yarn.cmd test --run
yarn.cmd storybookBuild the package locally:
yarn.cmd build
yarn.cmd test:consumersUsage
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:
semanticColorscolorsspaceradiitypographyfontSizes
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.jsonTesting
The project uses Vitest and Testing Library.
yarn.cmd test --runCurrent tests cover rendering, interactions, keyboard behavior, disabled behavior, ref forwarding, native prop pass-through, controlled state, form semantics, and accessibility expectations for primitives.
See Testing Strategy.
Storybook
Storybook is treated as the project documentation product.
yarn.cmd storybook
yarn.cmd build-storybookIt currently documents Overview, Getting Started, Foundations, Components, Guidelines, Accessibility, and Roadmap.
See Storybook Strategy.
Release Validation
Run the complete local release-readiness set:
yarn.cmd lint
yarn.cmd type-check
yarn.cmd test --run
yarn.cmd build
yarn.cmd build-storybook
yarn.cmd test:a11y
yarn.cmd test:visual
yarn.cmd test:consumers
npm.cmd pack --dry-runtest:consumers packs the library, installs that exact tarball into the React + Vite and Next.js fixtures, and runs their type-check and production builds.
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:
- Vision
- Architecture
- Surface System
- Component Language
- Layout Principles
- Component Guidelines
- Accessibility
- Releases
- FAQ
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.
