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

shakl

v0.0.19

Published

A utility to create styled components in React Native.

Downloads

9,335

Readme

Shakl

npm version Build Status

Features

  • Exposes basic primitives such as View, Text and Touchable,
  • Supports static and dynamic styles (based on props).
  • Supports component extension using extend() and attrs().
  • Supports component composition using withComponent() and withChild().
  • Uses regular inline styles under the hood (performance boost).
  • Works with React DOM too, same simple API, same benefits.
  • No dependencies, all just React goodness.
  • ~2 KB in size, with less than 100 lines of code.

Benchmark

Time required to create a simple styled component (in ms).

Install

yarn add shakl

Usage

Creating a styled component

import styled from 'shakl'

const Foo = styled(View)({ flex: 1 })

<Foo /> // <View style={{ flex: 1 }} />

Primitives

By default, React Native's View, Text, and TouchableOpacity are exposed to you, they can be directly used.

styled.View({ flex: 1 })
styled.Text({ color: 'blue' })
styled.Touchable({ padding: 10 })

// equivalent to
styled(View)({ flex: 1 })
styled(Text)({ color: 'blue' })
styled(TouchableOpacity)({ padding: 10 })

Dynamic styles

const Foo = styled.View((props) => ({ padding: props.padded ? 10 : 0 }))

<Foo /> // <View style={{ padding: 0 }} />
<Foo padded /> // <View style={{ padding: 10 }} />

Extending styles

const Title = styled.Text({ fontSize: 20 })
// <Text style={{ fontSize: 20 }} />

const BoldTitle = Title.extend({ fontWeight: 'bold' })
// <Text style={{ fontSize: 20, fontWeight: 'bold' }} />

const RedBoldTitle = BoldTitle.extend({ color: 'red' })
// <Text style={{ fontSize: 20, fontWeight: 'bold', color: 'red' }} />

const RedHeadline = styled(RedBoldTitle)({ fontSize: 28 }) // this works too

Custom props

const Foo = styled.Text({ color: 'blue' }).attrs({ numberOfLines: 1 })
// <Text style={{ color: 'blue' }} numberOfLines={1} />

// attrs({ .. }) only overwrites the `defaultProps` of the component
// for dynamic props however we can pass it a function

const MyText = styled.Text({ color: 'red' }).attrs((props) => ({
  numberOfLines: props.oneLiner ? 1 : 3
}))

// equivalent to
<MyText /> // <Text style={{ color: 'red }} numberOfLines={3} />
<MyText oneLiner /> // <Text style={{ color: 'red }} numberOfLines={1} />

Wrapping another component

const Button = styled(TouchableOpacity)({ flex: 1 })
const HighlightedButton = Button.withComponent(TouchableHighlight)

// equivalent to
const Button = (props) => <TouchableOpacity style={{ flex: 1 }} {...props} />

const HighlightedButton = (props) => (
  <TouchableHighlight style={{ flex: 1 }} {...props} />
)

Wrapping a child

const ButtonText = styled.Text({ color: 'blue' })
const Button = styled.Touchable({ flex: 1 }).withChild(ButtonText)

// equivalent to
const Button = ({ children, ...props }) => (
  <TouchableOpacity style={{ flex: 1 }} {...props}>
    <Text style={{ color: 'blue' }}>{children}</Text>
  </TouchableOpacity>
)

// to pass a ref to a child, use the `childRef` prop on the parent
// to pass custom props to a child, use `.withChild(Child, childProps)`
const CardText = styled.Text({ color: 'blue' })
const Card = styled.View({ flex: 1 }).withChild(CardText, { numberOfLines: 3 })

// equivalent to
const Card = ({ children, childRef, ...props }) => (
  <View style={{ flex: 1 }} {...props}>
    <Text ref={childRef} style={{ color: 'blue' }} numberOfLines={3}>
      {children}
    </Text>
  </View>
)

// you can also access parent props by passing a function `.withChild(Child, (parentProps) => childProps)`
const Card = styled.View({ flex: 1 }).withChild(CardText, (parentProps) => ({
  numberOfLines: parentProps.onLiner ? 1 : 3
}))

<Card />
// <View ..>
//   <Text ..>{children}</Text>
// </View>

<Card onLiner />
// <View ..>
//   <Text numberOfLines={1} ..>{children}</Text>
// </View>

Using refs

const List = styled(FlatList)({ flex: 1 })

<List ref={this.list} /> // based on React's forwardRef API (16.3.0)

// this.list.scrollTo({ y: 0 })
// or this.list.current.scrollTo({ y: 0 }) (with React.createRef)

Using a custom display name for debugging

styled(View, { name: 'YetAnotherView' })

Default display names are styled(View), styled(Text), styled(Touchable), styled(Component), etc.

Using propTypes and defaultProps

const Foo = styled.View({ flex: 1 })

Foo.propTypes = { .. }
Foo.defaultProps = { .. }

Usage with React DOM

Shakl is internally decoupled from React Native and can be used in the DOM.

import styled from 'shakl'

// no exposed primitives however, feel free to add your own
const styled.div = styled('div')

const Foo = styled.div({ background: '#eee' })

<Foo /> // <div style={{ background: '#eee' }} />

Edit shakl

Testing with Jest

Since Shakl supports both React Native and the DOM, we need to explicitly tell Jest that we are testing for React Native, otherwise it will test against the DOM by default, which causes exposed primitives to fail (.. shakl.default.View is not a function .. error).

// add the follwing to your Jest configuration when testing for React Native
"moduleNameMapper": {
  "shakl": "<rootDir>/node_modules/shakl/lib/rn.js"
}