{"id":18371104,"url":"https://github.com/welefen/grid-layout","last_synced_at":"2025-07-11T10:43:24.964Z","repository":{"id":141387014,"uuid":"217242803","full_name":"welefen/grid-layout","owner":"welefen","description":"grid-layout is a layout engine which implements grid, can used in canvas/node-canvas","archived":false,"fork":false,"pushed_at":"2020-06-04T08:11:05.000Z","size":429,"stargazers_count":56,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-23T19:47:16.868Z","etag":null,"topics":["css-grid","grid","grid-layout","layout"],"latest_commit_sha":null,"homepage":"https://welefen.com/lab/gridLayout/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/welefen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-10-24T07:53:00.000Z","updated_at":"2025-04-25T02:57:24.000Z","dependencies_parsed_at":null,"dependency_job_id":"f82033b4-a266-4497-8aea-5c83beeeb281","html_url":"https://github.com/welefen/grid-layout","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/welefen/grid-layout","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/welefen%2Fgrid-layout","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/welefen%2Fgrid-layout/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/welefen%2Fgrid-layout/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/welefen%2Fgrid-layout/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/welefen","download_url":"https://codeload.github.com/welefen/grid-layout/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/welefen%2Fgrid-layout/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264787337,"owners_count":23663936,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["css-grid","grid","grid-layout","layout"],"created_at":"2024-11-05T23:43:00.596Z","updated_at":"2025-07-11T10:43:24.938Z","avatar_url":"https://github.com/welefen.png","language":"TypeScript","readme":"# grid-layout\n\n\n\u003cdiv\u003e\n  \u003ca href=\"http://badge.fury.io/js/@welefen/grid-layout\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/v/@welefen/grid-layout.svg?style=flat-square\" alt=\"NPM version\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://travis-ci.org/welefen/grid-layout\"\u003e\n    \u003cimg src=\"https://img.shields.io/travis/welefen/grid-layout.svg?style=flat-square\" alt=\"travis-ci\" /\u003e\n  \u003c/a\u003e\n  \u003ca href='https://coveralls.io/github/welefen/grid-layout?branch=master'\u003e\u003cimg src='https://coveralls.io/repos/github/welefen/grid-layout/badge.svg?branch=master' alt='Coverage Status' /\u003e\u003c/a\u003e\n\n  \u003c!-- \u003ca href=\"https://www.npmjs.com/package/@welefen/grid-layout\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/dm/@welefen/grid-layout.svg?style=flat-square\" /\u003e --\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n\ngrid-layout is a layout engine which implements grid, can use in canvas/node-canvas.\n\nit's support most of features from https://www.w3.org/TR/css-grid-1/ except `direction/writing-mode` styles.\n\n## Install\n\n```\nnpm i @welefen/grid-layout\n```\n\n## Usage\n\n```html\n\u003cscript src=\"https://unpkg.com/@welefen/grid-layout/dist/gridLayout.js\"\u003e\u003c/script\u003e\n\u003cscript\u003e\nconst { Container, Node } = GridLayout;\n\u003c/script\u003e\n```\n\n```js\nimport { Container, Node } from '@welefen/grid-layout';\nconst container = new Container({ // containerOptions\n  width: 500,\n  height: 500\n});\n[\n  { width: 100, height: 100 },\n  { width: 100, height: 100 }\n].forEach(item =\u003e {\n  const node = new Node(item); // nodeOptions\n  container.appendChild(node);\n});\ncontainer.calculateLayout();\nconst result = container.getAllComputedLayout();\n// result is\n/**\n * {\n *  top: 0\n    left: 0\n    width: 500\n    height: 500,\n    children: [{\n      top: 0,\n      left: 0,\n      width: 100,\n      height: 100\n    }, ...]\n * }\n * /\n```\n\n### containerOptions\n\n\n```js\n{\n  gridAutoFlow?: string;\n  gridAutoColumns?: string;\n  gridAutoRows?: string;\n  gridColumnGap?: StringOrNumber;\n  gridRowGap?: StringOrNumber;\n  gridTemplateAreas?: string | string[][];\n  gridTemplateRows?: string;\n  gridTemplateColumns?: string;\n  width: number;\n  height: number;\n  alignItems?: SelfAlignment;\n  justifyItems?: SelfAlignment;\n  alignContent?: ContentAlignment;\n  justifyContent?: ContentAlignment;\n}\n```\n```js\ntype SelfAlignment = 'stretch' | 'center' | 'start' | 'end' | 'auto';\ntype ContentAlignment = 'stretch' | 'start' | 'center' | 'end' | 'space-between' | 'space-around' | 'space-evenly';\ntype StringOrNumber = string | number;\n\n```\n\n### gridTemplateAreas config\n\n```\n// string\n{\n  gridTemplateAreas: `\"a b c\"\n                      \"d e f\"`\n}\n\n// array\n{\n  gridTemplateAreas: [['a', 'b', 'c'],\n                      ['d', 'e', 'f']]\n}\n```\n\n\n### nodeOptions\n\n```js\n{\n  gridArea?: string;\n  gridColumnEnd?: StringOrNumber;\n  gridColumnStart?: StringOrNumber;\n  gridRowEnd?: StringOrNumber;\n  gridRowStart?: StringOrNumber;\n  alignSelf?: SelfAlignment;\n  justifySelf?: SelfAlignment;\n  paddingTop?: StringOrNumber;\n  paddingRight?: StringOrNumber;\n  paddingBottom?: StringOrNumber;\n  paddingLeft?: StringOrNumber;\n  padding?: any;\n  marginTop?: StringOrNumber;\n  marginRight?: StringOrNumber;\n  marginBottom?: StringOrNumber;\n  marginLeft?: StringOrNumber;\n  margin?: StringOrNumber;\n  borderTop?: StringOrNumber;\n  borderRight?: StringOrNumber;\n  borderBottom?: StringOrNumber;\n  borderLeft?: StringOrNumber;\n  border?: any;\n  width?: StringOrNumber;\n  height?: StringOrNumber;\n  boxSizing?: string;\n  order?: number;\n  minWidth?: StringOrNumber;\n  maxWidth?: StringOrNumber;\n  minHeight?: StringOrNumber;\n  maxHeight?: StringOrNumber;\n  minContentWidth?: StringOrNumber;\n  minContentHeight?: StringOrNumber;\n  maxContentWidth?: StringOrNumber;\n  maxContentHeight?: StringOrNumber;\n}\n```\n## Playground\n\n```sh\ngit clone git@github.com:welefen/grid-layout.git;\nnpm i;\nnpm run build;\ncd web;\nnpm i;\nnpm start;\n# then visit http://127.0.0.1:8080/\n```\n\nonline playground: https://welefen.com/lab/gridLayout/","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwelefen%2Fgrid-layout","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwelefen%2Fgrid-layout","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwelefen%2Fgrid-layout/lists"}