ui-cubic
v1.0.3
Published
Styled UI Components for React Web Apps
Downloads
16
Maintainers
Readme
UI-CUBIC
React primitive UI components built with styled-components.
npm i ui-cubic
or
yarn add ui-cubic
Getting Started
Note: For now, You have to wrap your main Component with CubeThemeProvider
import React from 'react'
import {Button, CubeThemeProvider} from 'ui-cubic'
export default props =>
<CubeThemeProvider>
<Button>UI-Cubic</Button>
</CubeThemeProvider>
By proving theme props you can customize styling
import React from 'react'
import {Button, CubeThemeProvider} from 'ui-cubic'
const theme = {
boxShadow: '0px 4px 15px rgba(211, 216, 224, 0.5)',
borderRadius: '5px',
palette: {
text: {
main: '#36434E',
light: '#9AA6AC',
},
primary: {
main: '#2F80ED',
text: '#fff',
hover: '#2F73DF',
active: '#2F80ED',
focus: '#2F80ED'
},
secondary: {
main: '#e3e7ea',
text: '#73839c',
hover: '#d3d7da',
active: '#d3d7da',
focus: '#d3d7da'
},
danger: {
main: '#FF2E63',
text: '#fff',
hover: '#FF2E63',
active: '#FF2E63',
focus: '#FF2E63'
},
warning: {
main: '#E7A324'
}
},
input: {
borderRadius: '10px',
colors: {
background: '#F1F3F5',
hover: '#EDEFF2',
label: '#8F9BB0',
placeholder: '#AEB7C6',
border: '#e0e0e0',
icon: '#9AA6AC'
}
}
}
export default props =>
<CubeThemeProvider theme={theme}>
<Button>UI-Cubic</Button>
</CubeThemeProvider>
When all values for theming is provided, the usage of CubeThemeProvider is not required, You can just pass cube object to Styled-Components's ThemeProvider
import React from 'react'
import {ThemeProvider} from 'styled-component'
import {Button, CubeThemeProvider} from 'ui-cubic'
const cubeTheme = {
boxShadow: '0px 4px 15px rgba(211, 216, 224, 0.5)',
borderRadius: '5px',
palette: {
text: {
main: '#36434E',
light: '#9AA6AC',
},
primary: {
main: '#2F80ED',
text: '#fff',
hover: '#2F73DF',
active: '#2F80ED',
focus: '#2F80ED'
},
secondary: {
main: '#e3e7ea',
text: '#73839c',
hover: '#d3d7da',
active: '#d3d7da',
focus: '#d3d7da'
},
danger: {
main: '#FF2E63',
text: '#fff',
hover: '#FF2E63',
active: '#FF2E63',
focus: '#FF2E63'
},
warning: {
main: '#E7A324'
}
},
input: {
borderRadius: '10px',
colors: {
background: '#F1F3F5',
hover: '#EDEFF2',
label: '#8F9BB0',
placeholder: '#AEB7C6',
border: '#e0e0e0',
icon: '#9AA6AC'
}
}
}
const theme = {
// Your values ...
....
//
cube: cubeTheme,
}
export default props =>
<ThemeProvider theme={theme}>
<Button>UI-Cubic</Button>
</CubeThemeProvider>
Principles
UI-Cubic is built with the following principles in mind.
- Minimal
- Useful
- Themeable