improve-why

mnajdova · Nov 7, 2020 · 829c896 · 829c896
1 parent 6a4630b
commit 829c896
Show file tree

Hide file tree

Showing 5 changed files with 153 additions and 63 deletions.
diff --git a/docs/src/pages/system/basics/Demo.js b/docs/src/pages/system/basics/Demo.js
@@ -1,7 +1,7 @@
 import * as React from 'react';
 import Box from '@material-ui/core/Box';
 import { alpha } from '@material-ui/core/styles';
-import ErrorIcon from '@material-ui/icons/Error';
+import ErrorOutlineIcon from '@material-ui/icons/ErrorOutline';
 
 export default function Demo() {
   return (
@@ -32,10 +32,10 @@ export default function Demo() {
         }}
       >
         <Box component="span" sx={{ fontSize: 16, mt: 1 }}>
-          123 Main St, Pheonix AZ
+          {'123 Main St, Pheonix AZ'}
         </Box>
         <Box component="span" sx={{ color: 'primary.main', fontSize: 22 }}>
-          $280,000 — $310,000
+          {'$280,000 — $310,000'}
         </Box>
         <Box
           sx={{
@@ -54,7 +54,7 @@ export default function Demo() {
             },
           }}
         >
-          <ErrorIcon />
+          <ErrorOutlineIcon />
           {'CONFIDENCE SCORE 85%'}
         </Box>
       </Box>

diff --git a/docs/src/pages/system/basics/Demo.tsx b/docs/src/pages/system/basics/Demo.tsx
@@ -1,7 +1,7 @@
 import * as React from 'react';
 import Box, { BoxProps } from '@material-ui/core/Box';
 import { alpha } from '@material-ui/core/styles';
-import ErrorIcon from '@material-ui/icons/Error';
+import ErrorOutlineIcon from '@material-ui/icons/ErrorOutline';
 
 export default function Demo() {
   return (
@@ -32,10 +32,10 @@ export default function Demo() {
         }}
       >
         <Box component="span" sx={{ fontSize: 16, mt: 1 }}>
-          123 Main St, Pheonix AZ
+          {'123 Main St, Pheonix AZ'}
         </Box>
         <Box component="span" sx={{ color: 'primary.main', fontSize: 22 }}>
-          $280,000 — $310,000
+          {'$280,000 — $310,000'}
         </Box>
         <Box
           sx={{
@@ -54,7 +54,7 @@ export default function Demo() {
             },
           }}
         >
-          <ErrorIcon />
+          <ErrorOutlineIcon />
           {'CONFIDENCE SCORE 85%'}
         </Box>
       </Box>

diff --git a/docs/src/pages/system/basics/Why.js b/docs/src/pages/system/basics/Why.js
@@ -0,0 +1,22 @@
+import * as React from 'react';
+import TrendingUpIcon from '@material-ui/icons/TrendingUp';
+import Box from '@material-ui/core/Box';
+
+export default function Why() {
+  return (
+    /* prettier-ignore */
+    <Box sx={{ bgcolor: 'background.paper', boxShadow: 1, borderRadius: 'borderRadius', p: 2, minWidth: 300 }}>
+      <Box sx={{ color: 'text.secondary' }}>Sessions</Box>
+      <Box sx={{ color: 'text.primary', fontSize: 34, fontWeight: 'fontWeightMedium' }}>
+        {'98.3 K'}
+      </Box>
+      <Box component={TrendingUpIcon} sx={{ color: 'success.dark', fontSize: 16, verticalAlign: 'sub' }} />
+      <Box sx={{ color: 'success.dark', display: 'inline', fontWeight: 'fontWeightMedium', mx: 0.5 }}>
+        {'18.77%'}
+      </Box>
+      <Box sx={{ color: 'text.secondary', display: 'inline', fontSize: 12 }}>
+        {'vs last week'}
+      </Box>
+    </Box>
+  );
+}
diff --git a/docs/src/pages/system/basics/Why.tsx b/docs/src/pages/system/basics/Why.tsx
@@ -0,0 +1,22 @@
+import * as React from 'react';
+import TrendingUpIcon from '@material-ui/icons/TrendingUp';
+import Box from '@material-ui/core/Box';
+
+export default function Why() {
+  return (
+    /* prettier-ignore */
+    <Box sx={{ bgcolor: 'background.paper', boxShadow: 1, borderRadius: 'borderRadius', p: 2, minWidth: 300 }}>
+      <Box sx={{ color: 'text.secondary' }}>Sessions</Box>
+      <Box sx={{ color: 'text.primary', fontSize: 34, fontWeight: 'fontWeightMedium' }}>
+        {'98.3 K'}
+      </Box>
+      <Box component={TrendingUpIcon} sx={{ color: 'success.dark', fontSize: 16, verticalAlign: 'sub' }} />
+      <Box sx={{ color: 'success.dark', display: 'inline', fontWeight: 'fontWeightMedium', mx: 0.5 }}>
+        {'18.77%'}
+      </Box>
+      <Box sx={{ color: 'text.secondary', display: 'inline', fontSize: 12 }}>
+        {'vs last week'}
+      </Box>
+    </Box>
+  );
+}
diff --git a/docs/src/pages/system/basics/basics.md b/docs/src/pages/system/basics/basics.md
@@ -2,74 +2,120 @@
 
 <p class="description">Utility-first style functions for rapidly building custom design systems.</p>
 
-The system lets you quickly build custom UI components leveraging the design tokens defined in your theme.
+Material-UI comes with dozens or **ready-to-use** components in the core.
+These components are an incredible starting point but when it comes to make your site stand out with a custom design, they can be challenging to customize. Introducing the system:
 
-## Demo
+The **system** lets you quickly build custom UI components leveraging the design tokens defined in your theme.
+
+## The demo
+
+_(Resize the window to see the responsive breakpoints)_
 
 {{"demo": "pages/system/basics/Demo.js", "bg": true, "defaultCodeOpen": true}}
 
-## Why
+## Why utility-first?
 
-There are several reasons why you may need the system offered by Material-UI. Here are few of them:
+Compare how the same stat component can be built with two different APIs.
 
-### 1. Building consistent UIs is hard
+{{"demo": "pages/system/basics/Why.js", "bg": true, "defaultCodeOpen": false}}
 
-This is especially true when there is more than one person building the application. There has to be some synchronization as to what the design tokens are and how they are used, what parts of the theme structure should be used with what CSS properties, etc.
+- ❌ using the standard styled-components API:
 
-### 2. Switching context
+```jsx
+const StatWrapper = styled('div')(
+  ({ theme }) => `
+  background-color: ${theme.palette.background.paper};
+  box-shadow: ${theme.shadows[1]};
+  border-radius: ${theme.shape.borderRadius}px;
+  padding: ${theme.spacing(2)};
+  min-width: 300px;
+`,
+);
+
+const StatHeader = styled('div')(
+  ({ theme }) => `
+  color: ${theme.palette.text.secondary};
+`,
+);
+
+const StyledTrend = styled(TrendingUpIcon)(
+  ({ theme }) => `
+  color: ${theme.palette.success.dark};
+  font-size: 16px;
+  vertical-alignment: sub;
+`,
+);
+
+const StatValue = styled('div')(
+  ({ theme }) => `
+  color: ${theme.palette.text.primary};
+  font-size: 34px;
+  font-weight: ${theme.typography.fontWeightMedium};
+`,
+);
+
+const StatDiff = styled('div')(
+  ({ theme }) => `
+  color: ${theme.palette.success.dark};
+  display: inline;
+  font-weight: ${theme.typography.fontWeightMedium};
+  margin-left: ${theme.spacing(0.5)};
+  margin-right: ${theme.spacing(0.5)};
+`,
+);
+
+const StatPrevious = styled('div')(
+  ({ theme }) => `
+  color: ${theme.palette.text.secondary};
+  display: inline;
+  font-size: 12px;
+`,
+);
+
+return (
+  <StatWrapper>
+    <StatHeader>Sessions</StatHeader>
+    <StatValue>{'98.3 K'}</StatValue>
+    <StyledTrend />
+    <StatDiff>{'18.77%'}</StatDiff>
+    <StatPrevious>{'vs last week'}</StatPrevious>
+  </StatWrapper>
+);
+```
 
-Often we find ourselves jumping from the JS to CSS, or from a component definition to an instance in order to understand where and how some styles are defined. This is particularly true as the complexity (LOCs/# of elements) of the component we are working on increases. We could save a lot of time by removing this constraint.
+- ✅ using the system:
 
-```diff
-import * as React from 'react';
--import styled from 'styled-components';
-+import Box from '@material-ui/core/Box';
-
--const Card = styled('div)({
--  width: '200px',
--  height: '200px',
--  boxShadow: theme => theme.shadows[3],
--});
--
--const Header = styled('h4')({
--  color: 'grey',
--});
--
--const Content = styled('p')({
--  fontSize: '14px;,
--  marginTop: '10px',
--});
-
-export default function Demo() {
--  return (<Card>
-+  return (<Box
-+    sx={{
-+      width: '200px',
-+      height: '200px',
-+      boxShadow: theme => theme.shadows[3],
-+    }}
-+  >
--    <Header>
-+    <Box component="h4" sx={{ color: 'grey' }}>
-       123 Main St, Pheonix AZ
--    </Header>
-+    </Box>
--    <Content>
-+    <Box component="p" sx={{
-+      fontSize: '14px;,
-+      marginTop: '10px',
-+    }}>
-      $280,000 — $310,000
--    </Content>
-+    </Box>
--  </Card>);
-+  </Box>);
-}
+```jsx
+<Box sx={{ bgcolor: 'background.paper', boxShadow: 1, borderRadius: 'borderRadius', p: 2, minWidth: 300 }}>
+  <Box sx={{ color: 'text.secondary' }}>Sessions</Box>
+  <Box sx={{ color: 'text.primary', fontSize: 34, fontWeight: 'fontWeightMedium' }}>
+    {'98.3 K'}
+  </Box>
+  <Box component={TrendingUpIcon} sx={{ color: 'success.dark', fontSize: 16, verticalAlign: 'sub' }} />
+  <Box sx={{ color: 'success.dark', display: 'inline', fontWeight: 'fontWeightMedium', mx: 0.5 }}>
+    {'18.77%'}
+  </Box>
+  <Box sx={{ color: 'text.secondary', display: 'inline', fontSize: 12 }}>
+    {'vs last week'}
+  </Box>
+</Box>
 ```
 
-### 3. Less code to type
+The system solves 3 problems:
+
+**1. Switching context wastes time.**
+
+There's no need to constantly jump between the usage of the styled components and where they are defined. With the system, those descriptions are right where you need them.
+
+**2. Naming things is hard.**
+
+Have you ever found yourself struggling to find a good name for a styled component?
+The system maps the styles directly to the element.
+All you have to do is worry about actual style properties.
+
+**3. Building consistent UIs is hard.**
 
-Usually when defining styles for a React component we need to either define a separate stylesheet, use some kind of factory for creating the component (`styled()`), or use some kind of hook for generating the styles (for example `makeStyles()` & `useStyles()`), which not only means we need to switch context from where we are currently in the code, but we need to also type much more code than the actual styles we want to have on some element.
+This is especially true when more than one person is building the application, as there has to be some coordination amongst members of the team regarding choice of design tokens and how they are used, what parts of the theme structure should be used with what CSS properties, and so on.
 
 ## How do we solve this?