React Native Styled System

Bring styled-system to React Native

Documentation

React Native Styled System is a React Native implementation of the styled-system package commonly used on the web.

Highlights

⚡️ All styles are allowed to be cached. So it doesn't cause any rerender if result is consistent.
⭐️ Allows arguments such as m, px, py, bg, flex, flexDirection, position to be passed directly to Props according to the grammar of styled-system.
🎨 Users can define the design system by directly defining and delivering themes.
❤️ TypeScript can be fully used through the Type Generation process using CLI.
🚀 Logical or responsive values such as safeAreaTop and sidePadding can be injected into the theme and used as token values.
💬 Text Typography
🎉 Integrate Dark Theme easily.

Why we need styled-system

Let me show this code.

const Sample = () => {
  const theme = useTheme();

  return (
    <View style={{
      backgroundColor: theme.colors.red500,
      borderRadius: theme.radii.lg
    }}>
      <Text style={[theme.typography.h1, { marginTop: theme.spaces[4] }]}>
        React Native
      </Text>
    </View>
  );
};

This is quite verbose.

With Styled System! 👇

const Sample = () => {
  return (
    <Box bg={'red500'} radius={'lg'}>
      <Txt t={'h1'} mt={4}>
        React Native
      </Txt>
    </Box>
  );
};

styled-system is useful for rapid UI development by providing a consistent approach to styling in React applications.

It offers a design system with predefined style props that streamline component styling, ensuring scalability, consistency, and responsive design.

But original styled-system is for CSS not in React Native.

We introduce React Native Styled System 🎉

Note

It does not fully support the grammar of styled-system and there are some grammars that are not currently supported, but this is not a technical limitation and will be added as needed.

Styles such as justifySelf that are not yet supported in React Native obviously cannot be added in the future.

Contributing

Feel like contributing? That's awesome! We have a contributing guide to help guide you.

Lincese

MIT

[FR]: Default style property in `useSx` option

Describe the problem

At now, the getStyle function takes SxProps as a parameter for passing additional style properties.

It is handled with lowest priority because it is used for default property sometimes.

We should separate a concern between defining default style properties and passing additional style properties.

Describe the solution

Step 1. Create `default(not fixed name)` options to `useSx` hook.

const { /* ... */ } = useSx(props, {
  default: {
    borderWidth: 1,
  },
});

Important

This SxProps should be handled as most lowest priority

Step 2(NEED DISCUSSION). The priority of `SxProps` as `getStyle` parameter should be highest one?(lower than `style`).

I have no idea how this priority should be updated.

Note

We should update this new behaviors in the docs.

Code of Conduct

I agree to follow this project's Code of Conduct

mj-studio-library / react-native-styled-system Goto Github PK