Skip to content

Clean up README comments #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Clean up README comments #52

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
68178ed
Clean up README comments.
westy92 Jun 16, 2021
cbf4bda
Missed a spot.
westy92 Jun 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,15 +114,15 @@ magicGrid.listen();
The MagicGrid constructor. Initializes the grid with a configuration object.
```javascript
let magicGrid = new MagicGrid({
container: "#container", // Required. Can be a class, id, or an HTMLElement
container: "#container", // Required. Can be a class, id, or an HTMLElement.
static: false, // Required for static content. Default: false.
items: 30, // Required for dynamic content. Initial number of items in the container.
gutter: 30, // Optional. Space between items. Default: 25(px).
maxColumns: 5, // Optional. Maximum number of columns. Default: Infinite.
useMin: true, // Optional. Prioritize shorter columns when positioning items? Default: false.
useTransform: true, // Optional. Position items using CSS transform? Default: True.
useTransform: true, // Optional. Position items using CSS transform? Default: true.
animate: true, // Optional. Animate item positioning? Default: false.
center: true, //Optional. Center the grid items? Default: true.
center: true, // Optional. Center the grid items? Default: true.
});
```

Expand All @@ -132,7 +132,7 @@ let magicGrid = new MagicGrid({
Positions the items and listens for changes to the window size. All items are repositioned whenever the window is resized.
```javascript
let magicGrid = new MagicGrid({
container: "#container", // Required. Can be a class, id, or an HTMLElement
container: "#container", // Required. Can be a class, id, or an HTMLElement.
static: true, // Required for static content.
animate: true, // Optional.
});
Expand All @@ -147,9 +147,9 @@ This function is useful in cases where you have to manually trigger a reposition

```javascript
let magicGrid = new MagicGrid({
container: "#container", // Required. Can be a class, id, or an HTMLElement
container: "#container", // Required. Can be a class, id, or an HTMLElement.
items: 30, // Required for dynamic content.
animate: true, // Optional
animate: true, // Optional.
});

magicGrid.listen();
Expand Down