Giter Club home page Giter Club logo

ui-box-plus's Introduction

ui-box-plus

It's ๐Ÿ“ฆ ui-box with extras ๐ŸŽ

NPM Version Downloads Stats

A fast and powerful React UI primitive for building components using CSS-in-JS. Extends ui-box with CSS shorthands, multi-type CSS props and integrates with styled components.

Install

โ˜๏ธ Don't forget to install the peer dependencies as well.

npm install ui-box-plus ui-box styled-components

Setup

Add the ThemeProvider from styled components to your app. There is only one required theme property: gridSize: number. This will be the size in pixels of one grid unit.

<ThemeProvider theme={{gridSize: 12}}>...</ThemeProvider>

Usage

Component

import El from "ui-box-plus";

const Button = (props) => (
    <El
      is="button" // Strings are taken 'as is'
      h="32px" // Most CSS shorthand notations are supported
      mb // Booleans are interpreted as 1 grid unit
      p={2} // Numbers are interpreted as number of grid units
      background={theme => theme.colors.warning} // Functions are given the styled component theme
      w={{desktop: 8, mobile: "100%"}} // Provide an object to handle different devices
      {...props}
    />
);

const Example = () => (
  <Button disabled mt={4}>Hi</Button>
);

Hook

ui-box-plus exports a hook for getting information about the device. It's used by the Element component when you provide an object prop. You may find it useful for creating responsive designs.

import { useDeviceInfo } from "ui-box-plus";

const { width, device } = useDeviceInfo();

interface DeviceInfo {
  width: number;
  device: "mobile" | "tablet" | "desktop" | "hd";
}

Release History

  • 0.2.0
    • Export useDeviceInfo hook.
  • 0.1.0
    • First release.

License

Distributed under the MIT license. See LICENSE for more information.

ui-box-plus's People

Watchers

Leon van der Grient avatar

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.