Skip to content

Commit dc513da

Browse files
committed
💥 Rename col → column in FlexGrid, Grid, Feed
1 parent 59faa2e commit dc513da

File tree

7 files changed

+71
-77
lines changed

7 files changed

+71
-77
lines changed

‎src/feed/about.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ import { Feed } from 'pss-components'
2727
```js
2828
<ThemeProvider theme={{ grid: 12 }}>
2929
<CurrentMediaProvider>
30-
<Feed space={2} col={{ all: 3, md: 6, sm: 12 }}>
30+
<Feed space={2} column={{ all: 3, md: 6, sm: 12 }}>
3131
<Feed.Item>
3232
Item
3333
</Feed.Item>
@@ -41,7 +41,7 @@ import { Feed } from 'pss-components'
4141
<Playground>
4242
<ThemeProvider theme={{ grid: 12 }}>
4343
<CurrentMediaProvider>
44-
<Feed space={2} col={{ all: 3, md: 6, sm: 12 }}>
44+
<Feed space={2} column={{ all: 3, md: 6, sm: 12 }}>
4545
<Feed.Item>
4646
<Box outline='1px solid' pd={1} minHeight={200}>1</Box>
4747
</Feed.Item>

‎src/feed/index.js

+5-4
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@ function FeedContainer ({
2727
currentMediaKey,
2828
theme = {},
2929
grid = theme.grid || DEFAULT_GRID,
30-
col = DEFAULT_GRID,
30+
column = DEFAULT_GRID,
3131
item,
3232
...rest
3333
}) {
3434
const itemCol = fallbackTo(
35-
col && fallbackTo(col[currentMediaKey[0]], col.all, col),
35+
column && fallbackTo(column[currentMediaKey[0]], column.all, column),
3636
grid
3737
)
3838
const groupSize = (grid / itemCol)
@@ -41,7 +41,7 @@ function FeedContainer ({
4141
return (
4242
<FlexGrid spaceTarget={FeedItem.toString()} {...rest}>
4343
{childrenGroups.map((child, index) => (
44-
<FlexGridItem key={`feed-item-${index}`} {...item} col={itemCol}>
44+
<FlexGridItem key={`feed-item-${index}`} {...item} column={itemCol}>
4545
{child}
4646
</FlexGridItem>
4747
))}
@@ -66,10 +66,11 @@ const Feed = compose(
6666

6767
Feed.propTypes = {
6868
grid: PropTypes.number,
69-
col: PropTypes.oneOfType([ PropTypes.number, PropTypes.objectOf(PropTypes.number) ])
69+
column: PropTypes.oneOfType([ PropTypes.number, PropTypes.objectOf(PropTypes.number) ])
7070
}
7171

7272
const FeedItem = styled(Box)``
73+
FeedItem.propTypes = { ...Box.propTypes }
7374
Feed.Item = FeedItem
7475

7576
export {

‎src/flex-grid/about.mdx

+22-22
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Grid component based on [`FlexBox`](#/flex-box).
3333

3434
#### `FlexGrid.Item` — Item / column component, size can be set with props:
3535

36-
- `col` — Number in range `1...theme.grid`
36+
- `column` — Number in range `1...theme.grid`
3737
- `size` — Number in range `0...1`, result is percentage (`0.5` is `50%`)
3838
- `offset` — Number in range `1...theme.grid` — move item by number of columns
3939

@@ -47,17 +47,17 @@ import { FlexGrid } from 'pss-components'
4747
```js
4848
<ThemeProvider theme={{ grid: 12 }}>
4949
<FlexGrid space={2}>
50-
<FlexGrid.Item col={6}>
50+
<FlexGrid.Item column={6}>
5151
<Box>
5252
Content
5353
</Box>
5454
</FlexGrid.Item>
55-
<FlexGrid.Item col={4}>
55+
<FlexGrid.Item column={4}>
5656
<Box>
5757
Content
5858
</Box>
5959
</FlexGrid.Item>
60-
<FlexGrid.Item col={2}>
60+
<FlexGrid.Item column={2}>
6161
<Box>
6262
Content
6363
</Box>
@@ -73,32 +73,32 @@ import { FlexGrid } from 'pss-components'
7373

7474
<Playground>
7575
<FlexGrid spacex={1}>
76-
<FlexGrid.Item col={2}>
76+
<FlexGrid.Item column={2}>
7777
<Box outline='1px solid' pd={1}>
7878
2
7979
</Box>
8080
</FlexGrid.Item>
81-
<FlexGrid.Item col={2}>
81+
<FlexGrid.Item column={2}>
8282
<Box outline='1px solid' pd={1}>
8383
2
8484
</Box>
8585
</FlexGrid.Item>
86-
<FlexGrid.Item col={2}>
86+
<FlexGrid.Item column={2}>
8787
<Box outline='1px solid' pd={1}>
8888
2
8989
</Box>
9090
</FlexGrid.Item>
91-
<FlexGrid.Item col={2}>
91+
<FlexGrid.Item column={2}>
9292
<Box outline='1px solid' pd={1}>
9393
2
9494
</Box>
9595
</FlexGrid.Item>
96-
<FlexGrid.Item col={2}>
96+
<FlexGrid.Item column={2}>
9797
<Box outline='1px solid' pd={1}>
9898
2
9999
</Box>
100100
</FlexGrid.Item>
101-
<FlexGrid.Item col={2}>
101+
<FlexGrid.Item column={2}>
102102
<Box outline='1px solid' pd={1}>
103103
2
104104
</Box>
@@ -111,42 +111,42 @@ import { FlexGrid } from 'pss-components'
111111
<Playground>
112112
<ThemeProvider theme={{ grid: 12 }}>
113113
<FlexGrid space={1}>
114-
<FlexGrid.Item col={1}>
114+
<FlexGrid.Item column={1}>
115115
<Box outline='1px solid' pd={1}>
116116
1
117117
</Box>
118118
</FlexGrid.Item>
119-
<FlexGrid.Item col={2}>
119+
<FlexGrid.Item column={2}>
120120
<Box outline='1px solid' pd={1}>
121121
2
122122
</Box>
123123
</FlexGrid.Item>
124-
<FlexGrid.Item col={3}>
124+
<FlexGrid.Item column={3}>
125125
<Box outline='1px solid' pd={1}>
126126
3
127127
</Box>
128128
</FlexGrid.Item>
129-
<FlexGrid.Item col={6}>
129+
<FlexGrid.Item column={6}>
130130
<Box outline='1px solid' pd={1}>
131131
6
132132
</Box>
133133
</FlexGrid.Item>
134-
<FlexGrid.Item col={12}>
134+
<FlexGrid.Item column={12}>
135135
<Box outline='1px solid' pd={1}>
136136
12
137137
</Box>
138138
</FlexGrid.Item>
139-
<FlexGrid.Item col={4}>
139+
<FlexGrid.Item column={4}>
140140
<Box outline='1px solid' pd={1}>
141141
4
142142
</Box>
143143
</FlexGrid.Item>
144-
<FlexGrid.Item col={4}>
144+
<FlexGrid.Item column={4}>
145145
<Box outline='1px solid' pd={1}>
146146
4
147147
</Box>
148148
</FlexGrid.Item>
149-
<FlexGrid.Item col={4}>
149+
<FlexGrid.Item column={4}>
150150
<Box outline='1px solid' pd={1}>
151151
4
152152
</Box>
@@ -159,22 +159,22 @@ import { FlexGrid } from 'pss-components'
159159

160160
<Playground>
161161
<FlexGrid space={1}>
162-
<FlexGrid.Item col={3} mgr='75%'>
162+
<FlexGrid.Item column={3} mgr='75%'>
163163
<Box outline='1px solid' pd={1}>
164164
3
165165
</Box>
166166
</FlexGrid.Item>
167-
<FlexGrid.Item col={3} offset={3}>
167+
<FlexGrid.Item column={3} offset={3}>
168168
<Box outline='1px solid' pd={1}>
169169
3
170170
</Box>
171171
</FlexGrid.Item>
172-
<FlexGrid.Item col={3} offset={6}>
172+
<FlexGrid.Item column={3} offset={6}>
173173
<Box outline='1px solid' pd={1}>
174174
3
175175
</Box>
176176
</FlexGrid.Item>
177-
<FlexGrid.Item col={3} offset={9}>
177+
<FlexGrid.Item column={3} offset={9}>
178178
<Box outline='1px solid' pd={1}>
179179
3
180180
</Box>

‎src/flex-grid/styles.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ const flexGridItemStyle = createStyles({
3737
marginLeft: size
3838
}
3939
},
40-
col (value, props) {
40+
column (value, props) {
4141
if (value === 'auto' || value === true) {
4242
return {
4343
flexGrow: 1,

‎src/grid/about.mdx

+30-30
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import { Grid } from './index'
1818
[Grid Layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Grid_Layout)
1919

2020
- Item conrolled with `col`, `row` prop in `Grid.Item` component
21-
- [Space](https://github.com/exah/pss/blob/master/docs/api.md#space) between items conrolled with `gap`, `gapx` and `gapy` props
21+
- [Space](https://github.com/exah/pss/blob/master/docs/api.md#space) between items conrolled with `gap`, `columnGap` and `rowGap` props
2222
- [Box alignment](https://rachelandrew.co.uk/css/cheatsheets/box-alignment) styles
2323

2424

@@ -27,12 +27,12 @@ import { Grid } from './index'
2727
#### `Grid` — Grid layout container
2828

2929
- `gap` — `grid-gap`
30-
- `gapx` — `grid-column-gap`
31-
- `gapy` — `grid-row-gap`
30+
- `columnGap` — `grid-column-gap`
31+
- `rowGap` — `grid-row-gap`
3232
- `autoFlow` — `grid-auto-flow`
33-
- `autoCols` — `grid-auto-columns`
33+
- `autoColumns` — `grid-auto-columns`
3434
- `autoRows` — `grid-auto-rows`
35-
- `templateCols` — `grid-template-columns`
35+
- `templateColumns` — `grid-template-columns`
3636
- `templateRows` — `grid-template-rows`
3737
- `templateAreas` — `grid-template-areas`
3838
- `alignItems` — `align-items`
@@ -43,7 +43,7 @@ import { Grid } from './index'
4343

4444
#### `Grid.Item`
4545

46-
- `col` — `grid-column`
46+
- `column` — `grid-column`
4747
- `row` — `grid-row`
4848
- `area` — `grod-area`
4949
- `justifySelf` — `justify-self`
@@ -59,13 +59,13 @@ import { Grid } from 'pss-components'
5959

6060
```js
6161
<Grid gap={2}>
62-
<Grid.Item col='span 6'>
62+
<Grid.Item column='span 6'>
6363
Content
6464
</Grid.Item>
65-
<Grid.Item col='span 4'>
65+
<Grid.Item column='span 4'>
6666
Content
6767
</Grid.Item>
68-
<Grid.Item col='span 2'>
68+
<Grid.Item column='span 2'>
6969
Content
7070
</Grid.Item>
7171
</Grid>
@@ -77,23 +77,23 @@ import { Grid } from 'pss-components'
7777
### Basic
7878

7979
<Playground>
80-
<Grid templateCols='repeat(12, 1fr)' gapx={1}>
81-
<Grid.Item col='span 2' outline='1px solid' pd={1}>
80+
<Grid templateColumns='repeat(12, 1fr)' columnGap={1}>
81+
<Grid.Item column='span 2' pd={1} outline='1px solid'>
8282
2
8383
</Grid.Item>
84-
<Grid.Item col='span 2' outline='1px solid' pd={1}>
84+
<Grid.Item column='span 2' pd={1} outline='1px solid'>
8585
2
8686
</Grid.Item>
87-
<Grid.Item col='span 2' outline='1px solid' pd={1}>
87+
<Grid.Item column='span 2' pd={1} outline='1px solid'>
8888
2
8989
</Grid.Item>
90-
<Grid.Item col='span 2' outline='1px solid' pd={1}>
90+
<Grid.Item column='span 2' pd={1} outline='1px solid'>
9191
2
9292
</Grid.Item>
93-
<Grid.Item col='span 2' outline='1px solid' pd={1}>
93+
<Grid.Item column='span 2' pd={1} outline='1px solid'>
9494
2
9595
</Grid.Item>
96-
<Grid.Item col='span 2' outline='1px solid' pd={1}>
96+
<Grid.Item column='span 2' pd={1} outline='1px solid'>
9797
2
9898
</Grid.Item>
9999
</Grid>
@@ -102,29 +102,29 @@ import { Grid } from 'pss-components'
102102
### Vertical and horizontal space between items
103103

104104
<Playground>
105-
<Grid templateCols='repeat(12, 1fr)' gap={1}>
106-
<Grid.Item col='span 1' outline='1px solid' pd={1}>
105+
<Grid templateColumns='repeat(12, 1fr)' gap={1}>
106+
<Grid.Item column='span 1' pd={1} outline='1px solid'>
107107
1
108108
</Grid.Item>
109-
<Grid.Item col='span 2' outline='1px solid' pd={1}>
109+
<Grid.Item column='span 2' pd={1} outline='1px solid'>
110110
2
111111
</Grid.Item>
112-
<Grid.Item col='span 3' outline='1px solid' pd={1}>
112+
<Grid.Item column='span 3' pd={1} outline='1px solid'>
113113
3
114114
</Grid.Item>
115-
<Grid.Item col='span 6' outline='1px solid' pd={1}>
115+
<Grid.Item column='span 6' pd={1} outline='1px solid'>
116116
6
117117
</Grid.Item>
118-
<Grid.Item col='span 12' outline='1px solid' pd={1}>
118+
<Grid.Item column='span 12' pd={1} outline='1px solid'>
119119
12
120120
</Grid.Item>
121-
<Grid.Item col='span 4' outline='1px solid' pd={1}>
121+
<Grid.Item column='span 4' pd={1} outline='1px solid'>
122122
4
123123
</Grid.Item>
124-
<Grid.Item col='span 4' outline='1px solid' pd={1}>
124+
<Grid.Item column='span 4' pd={1} outline='1px solid'>
125125
4
126126
</Grid.Item>
127-
<Grid.Item col='span 4' outline='1px solid' pd={1}>
127+
<Grid.Item column='span 4' pd={1} outline='1px solid'>
128128
4
129129
</Grid.Item>
130130
</Grid>
@@ -133,17 +133,17 @@ import { Grid } from 'pss-components'
133133
### Control each item `col` and `row` props
134134

135135
<Playground>
136-
<Grid templateCols='repeat(12, 1fr)' gap={1}>
137-
<Grid.Item row='1' col='1 / span 3' outline='1px solid' pd={1}>
136+
<Grid templateColumns='repeat(12, 1fr)' gap={1}>
137+
<Grid.Item row='1' column='1 / span 3' pd={1} outline='1px solid'>
138138
1
139139
</Grid.Item>
140-
<Grid.Item row='2' col='4 / span 3' outline='1px solid' pd={1}>
140+
<Grid.Item row='2' column='4 / span 3' pd={1} outline='1px solid'>
141141
2
142142
</Grid.Item>
143-
<Grid.Item row='3' col='7 / span 3' outline='1px solid' pd={1}>
143+
<Grid.Item row='3' column='7 / span 3' pd={1} outline='1px solid'>
144144
3
145145
</Grid.Item>
146-
<Grid.Item row='4' col='10 / span 3' outline='1px solid' pd={1}>
146+
<Grid.Item row='4' column='10 / span 3' pd={1} outline='1px solid'>
147147
4
148148
</Grid.Item>
149149
</Grid>

‎src/grid/index.js

+6-13
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,20 @@
11
import {
2-
createStyles,
3-
spaceRule,
42
createGridStyle,
53
createGridItemStyle,
64
boxContentAlignment,
7-
boxItemsAlignment
5+
boxItemsAlignment,
6+
gap
87
} from 'pss'
98

109
import React from 'react'
1110
import styled from '@emotion/styled'
1211
import { Box } from '../box'
1312

14-
const gridGap = createStyles({
15-
gap: [ spaceRule('gridGap'), spaceRule('gap') ],
16-
gapx: [ spaceRule('gridColumnGap'), spaceRule('columnGap') ],
17-
gapy: [ spaceRule('gridRowGap'), spaceRule('rowGap') ]
18-
})
19-
20-
const gridStyle = createGridStyle({ isShortPropNames: true })
21-
const gridItemStyle = createGridItemStyle({ isShortPropNames: true })
13+
const gridStyle = createGridStyle()
14+
const gridItemStyle = createGridItemStyle()
2215

2316
const StyledGrid = styled(Box)(
24-
gridGap,
17+
gap,
2518
gridStyle,
2619
boxContentAlignment,
2720
boxItemsAlignment
@@ -42,7 +35,7 @@ Grid.propTypes = {
4235
...gridStyle.propTypes,
4336
...boxContentAlignment.propTypes,
4437
...boxItemsAlignment.propTypes,
45-
...gridGap.propTypes,
38+
...gap.propTypes,
4639
...Box.propTypes
4740
}
4841

0 commit comments

Comments
 (0)