8000 GitHub - fictoan/fictoan: Monorepo with the React component library and docs together, for easier testing on local.
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

fictoan/fictoan

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

41 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Fictoan Framework

Fictoan

React version of the Fictoan framework
Fictoan is an intuitive React framework for designers looking to code and rapidly iterate on UI.


Yet another component library? No, sir! 🎨

What if a designer wrote static UI code, allowing the developer to focus more on integration, performance, deployments etc? Wouldn’t that be a massive time saver?

We want to blur the lines between a designer and a developer. Read our Manifesto 🌞


Key features ✨

For designers

  • Familiar like Figma: Props mirror properties in your favourite design toolβ€”bgColour, shadow, shape, marginBottom, weight and so on.
  • Theme to your heart’s content: Intricate control over every aspect of the UI
  • Iterate like crazy: Change properties as easily as you would in a design tool
  • For one and all: Accessible components and elements

For developers

  • Just your type: Fully typed, and a clean consistent component API
  • Light as a feather: ~14kb gzipped bundle size with no dependencies
  • Bare metal: Plain CSS styling, no JS bloat
  • Flexible: Easily extend and customise components
  • Modern Stack: Built with React 18+ and modern best practices

Getting started πŸš€

  1. Add Fictoan to your project:
yarn add fictoan-react
# or
pnpm add fictoan-react
# or
npm install fictoan-react
  1. Import and use components:
import { Card, Badge, Text } from "fictoan-react";

export const MyComponent = () => {
    return (
        <Card
            shape="rounded" padding="medium"
            bgColour="white" borderColor="slate-20"
            shadow="soft"
        >
            <Text size="large" weight="600">
                Simple, intuitive and obvious
            </Text>
            
            <Badge bgColor="blue-light40" textColour="blue">
                A complete no-brainer
            </Badge>
        </Card>
    );
}

Write UI code the way you’d speak 🧠

Doesn’t get simpler than thisβ€”

// Responsive layout
<Row gutters="large" horizontalPadding="small">
    <Portion desktopSpan="one-third" mobileSpan="14">
        <MyComponent />
    </Portion>
</Row>

// A form input
<InputField
    label="Email"
    placeholder="Enter your work email"
    helpText="Must be your primary ID"
    errorText="No such employee"
/>

// A primary button
<Button kind="primary" isFullWidth>
    Click me
</Button>

...and so much more.


Core principles 🎯

  • Intuitive props: Properties that make sense at first glance
  • Consistent patterns: Similar components share similar prop patterns
  • Design-Developer bridge: Make hand-off painless as possible
  • Minimal friction: Get from design to implementation faster

Documentation πŸ“š

Read our documentation to:

  • Explore the guides, boilerplate and component library
  • Check out the extensive theming and customisation ability with ~500 theme variables
  • See examples and use cases

Theming 🎨

Fictoan uses CSS variables for theming, with nearly 500 different variables that you can customise. Check it out!


Community and support πŸ’¬


License

Uses a simple MIT License. Have at it.


Built with β™₯️ for designers who code and developers who value design.


Fictoan Turborepo

A simple monorepo setup for Fictoan React component library and documentation site.

What’s included

  • packages/fictoan-react: The Fictoan React component library
  • packages/fictoan-docs: The documentation site for Fictoan

Development workflow

This monorepo is set up with a minimal, no-frills workflow for developing the Fictoan component library and documentation together.

Commands

  • yarn dev - Run the documentation site on localhost
  • yarn rebuild - Build the component library and update it in the docs site automatically

Getting started

  1. Clone this repository
  2. Run yarn install at the root
  3. Run yarn dev to start developing

Working on the component library

When making changes to the component library:

  1. Make your changes in packages/fictoan-react
  2. Run yarn updateLib to build the library and copy the files to the docs site
  3. The docs site will now use your latest changes

Repository Structure

fictoan-turborepo/
β”œβ”€β”€ packages/
β”‚   β”œβ”€β”€ fictoan-react/     # Component library
β”‚   └── fictoan-docs/      # Documentation site
β”œβ”€β”€ scripts/
β”‚   └── copy-lib.js        # Script to copy built files to docs
β”œβ”€β”€ turbo.json             # Turborepo configuration
└── package.json           # Root package.json with workspace config

About

Monorepo with the React component library and docs together, for easier testing on local.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published
0