@bedrock-layout/grid - npm Package Compare versions

Comparing version 2.2.2 to 2.2.3

package.json

 {
   "name": "@bedrock-layout/grid",
-  "version": "2.2.2",
+  "version": "2.2.3",
   "description": "bedrock-layout grid",
@@ -61,3 +61,3 @@ "sideEffects": false,
   },
-  "gitHead": "86d1e7998a54695be10cae6d28520a0f366e8e28"
+  "gitHead": "a911ed3a014fc7ded400b2b1b0047105693ccaca"
 }

README.md

 # `@bedrock-layout/grid`
 
-Layout helper that creates Grid of items
+Grid is a layout helper that creates a responsive grid of items.
 
 Full docs at: [bedrock-layout.dev](https://bedrock-layout.dev/)
 
+---
+
 ## When to Use
 
-Used to create a grid layouts
+`Grid` can be used to create a responsive grid layouts that can automatically wrap depending on the number of child elements and a `minItemWidth` value.
 
+---
+
 ## How to install
@@ -15,6 +19,12 @@
 
+or
+
+`yarn add @bedrock-layout/grid`
+
+---
+
 ## Usage
 
 ```javascript
-import Grid from '@bedrock-layout/grid';
+import { Grid } from '@bedrock-layout/grid';
 
@@ -31,6 +41,10 @@ <Grid minItemWidth={300}>
 
+---
+
 ## data-attribute
 
-For purposes of styling you can select `data-bedrock-grid`.
+For styling purposes, you can select `data-bedrock-grid`.
 
+---
+
 ## API
@@ -40,7 +54,7 @@
 
-| Property     | Description                       | Type                                   | Default               |
-| ------------ | --------------------------------- | -------------------------------------- | --------------------- |
-| gutter\*     | sets space inbetween each element | one of spacing\*\*                     | -                     |
-| minItemWidth | min width in px of each grid item | number or valid CSS length as a string | breakPoints.smallOnly |
+| Property     | Description                                   | Type                                   | Default               |
+| :----------: | :-------------------------------:             | :------------------------------------: | :-------------------: |
+| gutter\*     | sets the space between each child element     | One of `Spacing`\*\*                   | -                     |
+| minItemWidth | sets the min width size of each child element | number or valid CSS length as a string |  small (639px)        |
 
-\*\* By default, spacings are one of the [spacing-constants](https://github.com/Bedrock-Layouts/Bedrock/tree/main/packages/spacing-constants), but can be overridden using the `ThemeProvider` from `styled-components`
+\*\* By default, `Spacing` is one of [spacing-constants](https://github.com/Bedrock-Layouts/Bedrock/tree/main/packages/spacing-constants) values, but this can be overwritten using the `ThemeProvider` from `styled-components`

No alert changes

Improved metrics

Total package byte prevSize

11767

increased by2.33%

Number of lines in readme file

58

increased by31.82%

No dependency changes