JSPM

@frappefinance-libs/uikit

1.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
    • 0
  • Score
    100M100P100Q29156F
  • License MIT

Set of UI components for Frappe projects

Package Exports

  • @frappefinance-libs/uikit

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@frappefinance-libs/uikit) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Frappe Finance UIkit

Version Size

Frappe UIkit is a set of React components and hooks used to build pages on Frappe's apps.

It also contains a theme file for dark and light mode.

Install

yarn add @frappefinance-libs/uikit

npm

https://www.npmjs.com/package/@frappefinance-libs/uikit

Setup

Theme

Before using Frappe UIkit, you need to provide the theme file to styled-component.

import { ThemeProvider } from 'styled-components'
import { light, dark } from '@frappefinance-libs/uikit'
...
<ThemeProvider theme={isDark}>...</ThemeProvider>

Reset

A reset CSS is available as a global styled component.

import { ResetCSS } from '@frappefinance-libs/uikit'
...
<ResetCSS />

Types

This project is built with Typescript and export all the relevant types.

How to use the UIkit

If you want to use components from the UIkit, check the Storybook documentation