GithubHelp home page GithubHelp logo

phl3bas / tealeaf Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 1.83 MB

A beautifully modular UI toolkit

JavaScript 2.79% TypeScript 97.21%
css-framework design design-system designsystem cssframework webcomponents webcomponent web-components web-component reset

tealeaf's Introduction

Tealeaf

lerna

tealeaf logo

A Beautifully modular UI Tool Kit


What is Tealeaf?

Tealeaf is a modular UI tool kit which provides the user with, a design system, a classless css framework and reset, an atomic css framework and a web component library. The aim of Tealeaf is to provide a multi tierd UI kit, where developers can "buy-in" to as much of the system as they like, without feeling like alot of the design system/framework is going to waste.

What packages are available?

Tealeaf is broken down into four distinct packages.

@tealeaf/tokens

  • A curated set of design tokens declared at root level

@tealeaf/elements

  • A css normalisation and opinionated classless css framework

@tealeaf/css

  • A utility based css framework

@tealeaf/components

  • A flexible web component library (not yet released in beta)

running this project for development

git clone https://github.com/Phl3bas/Tealeaf.git

npm install

npm run tealeaf:init

build this project

in root dir

npm run build:tokens

npm run build:elements

npm run build:css

Disclaimer!!

Tealeaf and its packages are currently in developement and does not have a stable (1.x.x) release yet, because of this the api for the packages may be volatile between versions, it is encouraged to only to use the beta versions in non-production grade projects until a stable release has been announced! The current versions are available on npm/unpkg if you wish to use them!

npm install @tealeaf/tokens @tealeaf/elements @tealeaf/css

tealeaf's People

Contributors

phl3bas avatar

Stargazers

 avatar

Watchers

 avatar

tealeaf's Issues

@Element - table stylings (too opinionated?)

the alternating colours may come across as too opinionated and hard to override, maybe we should remove this and maybe give rows a light coloured border bottom or box shadow

@all : implement new size scale

implement new size scale

  • tokens
  • elements
  • css

1 - 10 = 1px - 10px

10 - 30 major third intervals rounded to the nearest even number

biggest width is now 888px (55.5rem)

@CSS - rename border utils

bc/bw/br/bs dont line up with other style names

proposed

border-[color]-[val] = bordercolor
border-[size] = border width
radius-[set] = border radius
border-[set] = border style

add side variants also

border-t
border-r
border-b
border-l

radius-tl
radius-tr
radius-br
radius-br
radius-t
radius-b
radius-r
radius-l

@Element - Base stylings for blockquotes

Look at matcha project for ideas, but also willing to look inspiration from other projects, I want this to look clean and simple, so a direct copy of matcha maybe a be too styled.

@elements - anchor tags styled like button text color not changing with text-{color} css class

This is an odd one, specificity shouldn't be an issue for the following reasons

  1. elements should be declared before css in stylesheet orders, so the new text color should be declared after the elements reset
  2. background color, which is declared with exact same selectors as color DOES change with bg-{color}

current workaround which has been implemented is to add !important to all css classes but this is sloppy, there must be a reason for this bug!

@Element - include base form stylings

base form styling should be make consistent

text inputs
selects, (this may be tricky)
radio buttons
checkboxes
text-areas

can include a figma file later for ideas if needed

@CSS - create build scripts

The build scripts from core are a good place to start.

script should take in a JavaScript config object for variable settings,

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.