styled theme

gestyltes Thema?

Themensystem für gestylerte Komponenten?

Installieren

 $ npm install --save styled-theme

Verwendung

Spielen Sie damit auf Webpackbin

 import styled from 'styled-components'
import { font , palette } from 'styled-theme' 

const Text = styled . span `
  font-family: ${ font ( 'primary' ) } ;
  background-color: ${ palette ( 1 ) } ;
  color: ${ palette ( 'grayscale' , 0 , true ) } ;
`

Text . defaultProps = {
  palette : 'primary'
} 

 < Text > Hello </ Text > 

 < Text reverse > Hello </ Text > 

 < Text palette = "secondary" > Hello </ Text >

Geben Sie Ihr eigenes Thema an

 import { ThemeProvider } from 'styled-components'

const xmasTheme = {
  fonts : {
    primary : 'Georgia, serif'
  } ,
  palette : {
    // red gradient
    primary : [ '#D32F2F' , '#F44336' , '#F8877F' , '#FFCDD2' ]
  }
}

< ThemeProvider theme = { xmasTheme } >
  < Text > Hello </ Text >
< / ThemeProvider>

Standard -Themenstruktur

Dies ist der Inhalt von src/theme.js :

 import coolorsToHex from 'coolors-to-hex'
import { reversePalette } from './composer'

const theme = { }

theme . palette = {
  primary : coolorsToHex ( 'https://coolors.co/1976d2-2196f3-71bcf7-97cef9-c2e2fb' ) ,
  secondary : coolorsToHex ( 'https://coolors.co/c2185b-e91e63-f06292-f48caf-f8bbd0' ) ,
  danger : coolorsToHex ( 'https://coolors.co/d32f2f-f44336-f8877f-f9a7a1-ffcdd2' ) ,
  alert : coolorsToHex ( 'https://coolors.co/ffa000-ffc107-ffd761-ffecb3-fff2ce' ) ,
  success : coolorsToHex ( 'https://coolors.co/388e3c-4caf50-7cc47f-9fd4a1-c8e6c9' ) ,
  grayscale : [ '#212121' , '#616161' , '#9e9e9e' , '#bdbdbd' , '#e0e0e0' , '#ffffff' ]
}

theme . reversePalette = reversePalette ( theme . palette )

theme . fonts = {
  primary : 'Helvetica Neue, Helvetica, Roboto, sans-serif' ,
  pre : 'Consolas, Liberation Mono, Menlo, Courier, monospace' ,
  quote : 'Georgia, serif'
}

theme . sizes = {
  maxWidth : '1100px'
}

export default theme

reversePalette ist eine Helfermethode. Importieren Sie es aus styled-theme/composer .

API

Reversepalette

Die Palette zurückkehren

Parameter

• palette Palette

Beispiele

 reversePalette ( { primary : [ 'red' , 'yellow' , 'green' ] } )
// { primary: ['green', 'yellow', 'red'] }

Gibt die Palette zurück

Schlüssel

Gibt den Wert von props.theme[path] oder styledTheme[path] zurück.

Parameter

• path (String | Array <string>)
• defaultValue alle

Beispiele

 const Button = styled . button `
 font-family: ${ key ( 'fonts.primary' ) } ;
 color: ${ key ( [ 'colors' , 'primary' , 0 ] ) } ;
`

Gibt alle zurück

Schriftart

Kurzschrift zum key(['fonts', path])

Parameter

• path String
• defaultValue alle

Beispiele

 const Button = styled . button `
 font-family: ${ font ( 'primary' ) } ;
`

Gibt Schriftart zurück

Größe

Abkürzung zu key(['sizes', path])

Parameter

• path String
• defaultValue alle

Beispiele

 const Button = styled . button `
 padding: ${ size ( 'padding' ) } ;
`

Rücksendungen

Palette

Gibt den Wert von props.theme[palette || reversePalette][path][index] oder styledTheme[palette || reversePalette][path][index] (Standardthema)

Die Argumente können in beliebiger Reihenfolge übergeben werden, solange die Typen aufbewahrt werden.

Parameter

• index Der Tonindex in Themenpaletten -Tones -Array
• path String? Der Schlüssel der Töne im Themenpalette -Objekt (optionale, Standard props.palette )
• exceptions Objekt? Ein Objekt mit Pfad als Schlüssel und Index als Wert
• reverse boolean? Flagge, um den Ton von reversePalette oder palette zurückzugeben
• defaultValue -Zeichenfolge? Standardwert
• args ... anywein

Beispiele

 // index = 1
// exception = { grayscale: 0 }
// reverse = true
const Button = styled . button `
 background-color: ${ palette ( { grayscale : 0 } , 1 , true ) } ;
`

// renders props.theme.reversePalette.grayscale[0]
< Button palette = "grayscale" / >

// renders props.theme.palette.danger[1] (nullify reverse)
< Button palette = "danger" reverse />

Gibt Töne zurück

Ton

Typ: Zeichenfolge

Töne

Typ: Array <ton>

Schriftart

Typ: Zeichenfolge

Größe

Typ: Zeichenfolge

Palette

Typ: {}

Schriftarten

Typ: {}

Größen

Typ: {}

Thema

Typ: {Palette: Palette ?, ReversePalette: Palette ?, Schriftarten: Schriftarten?, Größen?}

Verwandt

• Gestaltete Tools-Dienstprogramme für gestylerte Komponenten (wie Lodash)

Lizenz

MIT © Diego Haz