From d421d6805478cb345e7931d8ca240fb3d630161f Mon Sep 17 00:00:00 2001 From: Dustin Falgout Date: Mon, 20 Jul 2020 01:39:50 -0500 Subject: [PATCH] fix: More updates to style guides. build: [skip-ci] --- README.md | 5 +- css-in-javascript/README.md | 432 ------------------------------------ react/README.md | 347 ++++++++++++----------------- 3 files changed, 140 insertions(+), 644 deletions(-) delete mode 100644 css-in-javascript/README.md diff --git a/README.md b/README.md index 26efcd7f9d..ef7ea76506 100644 --- a/README.md +++ b/README.md @@ -3719,12 +3719,11 @@ Other Style Guides **Tools** - Code Style Linters - - [ESlint](https://eslint.org/) - [Airbnb Style .eslintrc](https://github.com/elegantthemes/javascript/blob/master/linters/.eslintrc) - - [JSHint](http://jshint.com/) - [Airbnb Style .jshintrc](https://github.com/elegantthemes/javascript/blob/master/linters/.jshintrc) - - Neutrino Preset - [@neutrinojs/airbnb](https://neutrinojs.org/packages/airbnb/) + - [ESlint](https://eslint.org/) - [Elegant Themes Style .eslintrc](https://github.com/elegantthemes/javascript/blob/master/linters/.eslintrc) **Other Style Guides** + - [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript) - [Google JavaScript Style Guide](https://google.github.io/styleguide/jsguide.html) - [Google JavaScript Style Guide (Old)](https://google.github.io/styleguide/javascriptguide.xml) - [jQuery Core Style Guidelines](https://contribute.jquery.org/style-guide/js/) diff --git a/css-in-javascript/README.md b/css-in-javascript/README.md deleted file mode 100644 index d6162df55d..0000000000 --- a/css-in-javascript/README.md +++ /dev/null @@ -1,432 +0,0 @@ -# Airbnb CSS-in-JavaScript Style Guide - -*A mostly reasonable approach to CSS-in-JavaScript* - -## Table of Contents - -1. [Naming](#naming) -1. [Ordering](#ordering) -1. [Nesting](#nesting) -1. [Inline](#inline) -1. [Themes](#themes) - -## Naming - - - Use camelCase for object keys (i.e. "selectors"). - - > Why? We access these keys as properties on the `styles` object in the component, so it is most convenient to use camelCase. - - ```js - // bad - { - 'bermuda-triangle': { - display: 'none', - }, - } - - // good - { - bermudaTriangle: { - display: 'none', - }, - } - ``` - - - Use an underscore for modifiers to other styles. - - > Why? Similar to BEM, this naming convention makes it clear that the styles are intended to modify the element preceded by the underscore. Underscores do not need to be quoted, so they are preferred over other characters, such as dashes. - - ```js - // bad - { - bruceBanner: { - color: 'pink', - transition: 'color 10s', - }, - - bruceBannerTheHulk: { - color: 'green', - }, - } - - // good - { - bruceBanner: { - color: 'pink', - transition: 'color 10s', - }, - - bruceBanner_theHulk: { - color: 'green', - }, - } - ``` - - - Use `selectorName_fallback` for sets of fallback styles. - - > Why? Similar to modifiers, keeping the naming consistent helps reveal the relationship of these styles to the styles that override them in more adequate browsers. - - ```js - // bad - { - muscles: { - display: 'flex', - }, - - muscles_sadBears: { - width: '100%', - }, - } - - // good - { - muscles: { - display: 'flex', - }, - - muscles_fallback: { - width: '100%', - }, - } - ``` - - - Use a separate selector for sets of fallback styles. - - > Why? Keeping fallback styles contained in a separate object clarifies their purpose, which improves readability. - - ```js - // bad - { - muscles: { - display: 'flex', - }, - - left: { - flexGrow: 1, - display: 'inline-block', - }, - - right: { - display: 'inline-block', - }, - } - - // good - { - muscles: { - display: 'flex', - }, - - left: { - flexGrow: 1, - }, - - left_fallback: { - display: 'inline-block', - }, - - right_fallback: { - display: 'inline-block', - }, - } - ``` - - - Use device-agnostic names (e.g. "small", "medium", and "large") to name media query breakpoints. - - > Why? Commonly used names like "phone", "tablet", and "desktop" do not match the characteristics of the devices in the real world. Using these names sets the wrong expectations. - - ```js - // bad - const breakpoints = { - mobile: '@media (max-width: 639px)', - tablet: '@media (max-width: 1047px)', - desktop: '@media (min-width: 1048px)', - }; - - // good - const breakpoints = { - small: '@media (max-width: 639px)', - medium: '@media (max-width: 1047px)', - large: '@media (min-width: 1048px)', - }; - ``` - -## Ordering - - - Define styles after the component. - - > Why? We use a higher-order component to theme our styles, which is naturally used after the component definition. Passing the styles object directly to this function reduces indirection. - - ```jsx - // bad - const styles = { - container: { - display: 'inline-block', - }, - }; - - function MyComponent({ styles }) { - return ( -
- Never doubt that a small group of thoughtful, committed citizens can - change the world. Indeed, it’s the only thing that ever has. -
- ); - } - - export default withStyles(() => styles)(MyComponent); - - // good - function MyComponent({ styles }) { - return ( -
- Never doubt that a small group of thoughtful, committed citizens can - change the world. Indeed, it’s the only thing that ever has. -
- ); - } - - export default withStyles(() => ({ - container: { - display: 'inline-block', - }, - }))(MyComponent); - ``` - -## Nesting - - - Leave a blank line between adjacent blocks at the same indentation level. - - > Why? The whitespace improves readability and reduces the likelihood of merge conflicts. - - ```js - // bad - { - bigBang: { - display: 'inline-block', - '::before': { - content: "''", - }, - }, - universe: { - border: 'none', - }, - } - - // good - { - bigBang: { - display: 'inline-block', - - '::before': { - content: "''", - }, - }, - - universe: { - border: 'none', - }, - } - ``` - -## Inline - - - Use inline styles for styles that have a high cardinality (e.g. uses the value of a prop) and not for styles that have a low cardinality. - - > Why? Generating themed stylesheets can be expensive, so they are best for discrete sets of styles. - - ```jsx - // bad - export default function MyComponent({ spacing }) { - return ( -
- ); - } - - // good - function MyComponent({ styles, spacing }) { - return ( -
- ); - } - export default withStyles(() => ({ - periodic: { - display: 'table', - }, - }))(MyComponent); - ``` - -## Themes - - - Use an abstraction layer such as [react-with-styles](https://github.com/airbnb/react-with-styles) that enables theming. *react-with-styles gives us things like `withStyles()`, `ThemedStyleSheet`, and `css()` which are used in some of the examples in this document.* - - > Why? It is useful to have a set of shared variables for styling your components. Using an abstraction layer makes this more convenient. Additionally, this can help prevent your components from being tightly coupled to any particular underlying implementation, which gives you more freedom. - - - Define colors only in themes. - - ```js - // bad - export default withStyles(() => ({ - chuckNorris: { - color: '#bada55', - }, - }))(MyComponent); - - // good - export default withStyles(({ color }) => ({ - chuckNorris: { - color: color.badass, - }, - }))(MyComponent); - ``` - - - Define fonts only in themes. - - ```js - // bad - export default withStyles(() => ({ - towerOfPisa: { - fontStyle: 'italic', - }, - }))(MyComponent); - - // good - export default withStyles(({ font }) => ({ - towerOfPisa: { - fontStyle: font.italic, - }, - }))(MyComponent); - ``` - - - Define fonts as sets of related styles. - - ```js - // bad - export default withStyles(() => ({ - towerOfPisa: { - fontFamily: 'Italiana, "Times New Roman", serif', - fontSize: '2em', - fontStyle: 'italic', - lineHeight: 1.5, - }, - }))(MyComponent); - - // good - export default withStyles(({ font }) => ({ - towerOfPisa: { - ...font.italian, - }, - }))(MyComponent); - ``` - - - Define base grid units in theme (either as a value or a function that takes a multiplier). - - ```js - // bad - export default withStyles(() => ({ - rip: { - bottom: '-6912px', // 6 feet - }, - }))(MyComponent); - - // good - export default withStyles(({ units }) => ({ - rip: { - bottom: units(864), // 6 feet, assuming our unit is 8px - }, - }))(MyComponent); - - // good - export default withStyles(({ unit }) => ({ - rip: { - bottom: 864 * unit, // 6 feet, assuming our unit is 8px - }, - }))(MyComponent); - ``` - - - Define media queries only in themes. - - ```js - // bad - export default withStyles(() => ({ - container: { - width: '100%', - - '@media (max-width: 1047px)': { - width: '50%', - }, - }, - }))(MyComponent); - - // good - export default withStyles(({ breakpoint }) => ({ - container: { - width: '100%', - - [breakpoint.medium]: { - width: '50%', - }, - }, - }))(MyComponent); - ``` - - - Define tricky fallback properties in themes. - - > Why? Many CSS-in-JavaScript implementations merge style objects together which makes specifying fallbacks for the same property (e.g. `display`) a little tricky. To keep the approach unified, put these fallbacks in the theme. - - ```js - // bad - export default withStyles(() => ({ - .muscles { - display: 'flex', - }, - - .muscles_fallback { - 'display ': 'table', - }, - }))(MyComponent); - - // good - export default withStyles(({ fallbacks }) => ({ - .muscles { - display: 'flex', - }, - - .muscles_fallback { - [fallbacks.display]: 'table', - }, - }))(MyComponent); - - // good - export default withStyles(({ fallback }) => ({ - .muscles { - display: 'flex', - }, - - .muscles_fallback { - [fallback('display')]: 'table', - }, - }))(MyComponent); - ``` - - - Create as few custom themes as possible. Many applications may only have one theme. - - - Namespace custom theme settings under a nested object with a unique and descriptive key. - - ```js - // bad - ThemedStyleSheet.registerTheme('mySection', { - mySectionPrimaryColor: 'green', - }); - - // good - ThemedStyleSheet.registerTheme('mySection', { - mySection: { - primaryColor: 'green', - }, - }); - ``` - ---- - -CSS puns adapted from [Saijo George](https://saijogeorge.com/css-puns/). diff --git a/react/README.md b/react/README.md index 99518e5a75..45cff36348 100644 --- a/react/README.md +++ b/react/README.md @@ -1,6 +1,6 @@ # Airbnb React/JSX Style Guide -*A mostly reasonable approach to React and JSX* +*A truly reasonable approach to React and JSX* This style guide is mostly based on the standards that are currently prevalent in JavaScript, although some conventions (i.e async/await or static class fields) may still be included or prohibited on a case-by-case basis. Currently, anything prior to stage 3 is not included nor recommended in this guide. @@ -83,7 +83,7 @@ This style guide is mostly based on the standards that are currently prevalent i - **Extensions**: Use `.jsx` extension for React components. eslint: [`react/jsx-filename-extension`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-filename-extension.md) - **Filename**: Use PascalCase for filenames. E.g., `ReservationCard.jsx`. - - **Reference Naming**: Use PascalCase for React components and camelCase for their instances. eslint: [`react/jsx-pascal-case`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-pascal-case.md) + - **Reference Naming**: Use PascalCase for React components and snake_case for their instances. eslint: [`react/jsx-pascal-case`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-pascal-case.md) ```jsx // bad @@ -96,7 +96,7 @@ This style guide is mostly based on the standards that are currently prevalent i const ReservationItem = ; // good - const reservationItem = ; + const reservation_item = ; ``` - **Component Naming**: Use the filename as the component name. For example, `ReservationCard.jsx` should have a reference name of `ReservationCard`. However, for root components of a directory, use `index.jsx` as the filename and use the directory name as the component name: @@ -189,10 +189,7 @@ This style guide is mostly based on the standards that are currently prevalent i // children get indented normally - + @@ -207,7 +204,7 @@ This style guide is mostly based on the standards that are currently prevalent i