UNPKG

react-masonry

Version:
438 lines 8.53 kB
{ "id": 0, "name": "react-masonry", "kind": 1, "kindString": "Project", "flags": {}, "originalName": "", "children": [ { "id": 1, "name": "MasonryProps", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 5, "name": "enterOneAfterAnother", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "When transition is set, stones can appear one after the other." } ], "blockTags": [ { "tag": "@defaults", "content": [ { "kind": "text", "text": "false" } ] } ] }, "sources": [ { "fileName": "types.ts", "line": 27, "character": 2, "url": "https://github.com/bogdanpetru/react-masonry/blob/61db6e7/packages/react-masonry/src/types.ts#L27" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 2, "name": "gutter", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Defines the spacing between stones." } ], "blockTags": [ { "tag": "@defaults", "content": [ { "kind": "text", "text": "0" } ] }, { "tag": "@deprecated", "content": [ { "kind": "text", "text": "- no use for gutter, use css instead, e.g. padding" } ] } ] }, "sources": [ { "fileName": "types.ts", "line": 9, "character": 2, "url": "https://github.com/bogdanpetru/react-masonry/blob/61db6e7/packages/react-masonry/src/types.ts#L9" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 9, "name": "style", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Style applied on the top element" } ], "blockTags": [ { "tag": "@defaults", "content": [ { "kind": "text", "text": "none" } ] } ] }, "sources": [ { "fileName": "types.ts", "line": 52, "character": 2, "url": "https://github.com/bogdanpetru/react-masonry/blob/61db6e7/packages/react-masonry/src/types.ts#L52" } ], "type": { "type": "reference", "name": "CSSProperties", "qualifiedName": "React.CSSProperties", "package": "@types/react" } }, { "id": 3, "name": "transition", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "If different than false, each item will appear one after another with an interval of " }, { "kind": "code", "text": "`transitionStep`" }, { "kind": "text", "text": " in between." } ], "blockTags": [ { "tag": "@defaults", "content": [ { "kind": "text", "text": "false" } ] } ] }, "sources": [ { "fileName": "types.ts", "line": 15, "character": 2, "url": "https://github.com/bogdanpetru/react-masonry/blob/61db6e7/packages/react-masonry/src/types.ts#L15" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": false }, { "type": "literal", "value": "fade" }, { "type": "literal", "value": "fadeMove" } ] } }, { "id": 6, "name": "transitionDuration", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Speed with which stones are placed when " }, { "kind": "code", "text": "`enterOneAfterAnother=true`" } ], "blockTags": [ { "tag": "@defaults", "content": [ { "kind": "text", "text": "300" } ] } ] }, "sources": [ { "fileName": "types.ts", "line": 33, "character": 2, "url": "https://github.com/bogdanpetru/react-masonry/blob/61db6e7/packages/react-masonry/src/types.ts#L33" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 4, "name": "transitionStep", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Time (in ms) in between each stone placement, this is relevant if " }, { "kind": "code", "text": "`transition`" }, { "kind": "text", "text": " prop is not " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": "." } ], "blockTags": [ { "tag": "@defaults", "content": [ { "kind": "text", "text": "50" } ] } ] }, "sources": [ { "fileName": "types.ts", "line": 21, "character": 2, "url": "https://github.com/bogdanpetru/react-masonry/blob/61db6e7/packages/react-masonry/src/types.ts#L21" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 7, "name": "updateOnWindowResize", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Replaces the stones when windows changes size." } ], "blockTags": [ { "tag": "@defaults", "content": [ { "kind": "text", "text": "true" } ] } ] }, "sources": [ { "fileName": "types.ts", "line": 39, "character": 2, "url": "https://github.com/bogdanpetru/react-masonry/blob/61db6e7/packages/react-masonry/src/types.ts#L39" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 8, "name": "updateOnWindowResizeDebounceWait", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Related to " }, { "kind": "code", "text": "`updateOnWindowResize`" }, { "kind": "text", "text": ".\n Window resize listener is debouced, this sets the wait time." } ], "blockTags": [ { "tag": "@defaults", "content": [ { "kind": "text", "text": "300" } ] } ] }, "sources": [ { "fileName": "types.ts", "line": 46, "character": 2, "url": "https://github.com/bogdanpetru/react-masonry/blob/61db6e7/packages/react-masonry/src/types.ts#L46" } ], "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Properties", "children": [ 5, 2, 9, 3, 6, 4, 7, 8 ] } ], "sources": [ { "fileName": "types.ts", "line": 3, "character": 17, "url": "https://github.com/bogdanpetru/react-masonry/blob/61db6e7/packages/react-masonry/src/types.ts#L3" } ] } ], "groups": [ { "title": "Interfaces", "children": [ 1 ] } ], "sources": [ { "fileName": "types.ts", "line": 1, "character": 0, "url": "https://github.com/bogdanpetru/react-masonry/blob/61db6e7/packages/react-masonry/src/types.ts#L1" } ] }