npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@siteone/system-core

v1.0.0

Published

Design system core packages

Downloads

79

Readme

@siteone/system-core

package version package downloads standard-readme compliant package license make a pull request

Design system core packages

Table of Contents

Install

This project uses node and npm.

$ npm install @siteone/system-core
$ # OR
$ yarn add @siteone/system-core

Usage

Element

Base design system component with styling props and responsive superpowers

propTypes

Content alignment

Contexts

NestedThemeProvider

Uses specific theme context for all enclosed design system components.

Examples

import { NestedThemeProvider } from '@siteone/system-core'
import { Section } from '@siteone/system-components'
import React from 'react'

const MyComponent = () =>
   <NestedThemeProvider name='inverse'>
     <Section>This component and its children will be inverse (if inverse theme context is specified).</Section>
   </NestedThemeProvider>

ThemeProvider

Root theme provider. Must be at the topmost level of application. Provides base CSS normalization, base theme extended by theme provided and complete theme for enclosed application.

Examples

import { ThemeProvider } from '@siteone/system-core'
import React from 'react'
import theme from './my-theme'

const MyApp = () =>
   <ThemeProvider theme={theme}>
     <div>My application goes here</div>
   </ThemeProvider>

Creators

createGroup

Creates a factory function for creating themeable components in specified group

Parameters

  • groupName {string} Component group (type] name should be pascal case singular(ex. Text, Button]
  • groupBaseComponent {React$Component} Component to use for this group (overridable by specific component in this group) default: Element

Examples

import * as React from 'react'
import { withInteractivity, createGroup } from '@siteone/system-core'

// create factory for component group "text"
const createComponent = createGroup('text')
// create themeable component within that group
const MyHeading = createComponent('MyHeading', 'h1', Element)

export { MyHeading }

Returns createComponent Component creator for group

createComponent

Parameters

  • componentName string {string} Component name
  • as string {string} HTML tag name
  • baseComponent React$Component<any, any> {React$Component} Component to use for this specific component

Returns React$Component<any, any>

withInteractivity

Adds tappable states handling and theming support to themeable component

Parameters

  • ThemeableComponent Themeable component to extend

Examples

import * as React from 'react'
import { withInteractivity, createStaticComponentGroup } from '@siteone/system-components'

// create factory for component group "buttons"
const createComponent = createStaticComponentGroup('buttons')
// create component and make it interactive
const MyButton = withInteractivity( createComponent('MyButton', 'button', Element) )

export { MyButton }

  • See: @emotion/core

styled

  • See: @emotion/styled

Contribute

  1. Fork it and create your feature branch: git checkout -b my-new-feature
  2. Commit your changes: git commit -am "Add some feature"
  3. Push to the branch: git push origin my-new-feature
  4. Submit a pull request

License

MIT © SiteOne, contributors, sourced packages authors & contributors