UNPKG

@hope-ui/solid

Version:

The SolidJS component library you've hoped for.

191 lines 7.32 kB
import { Property } from "csstype"; import { KeysOf, SpaceScaleValue } from "../types"; /** * Types for CSS grid properties */ export declare type GridLayoutProps = Partial<{ /** * The CSS `grid-template` property. * * It is a shorthand property for defining grid columns, rows, and areas. * * @see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template) */ gridTemplate: Property.GridTemplate; /** * The CSS `grid-template-columns` property * * It defines the line names and track sizing functions of the grid columns. * * @see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns) */ gridTemplateColumns: Property.GridTemplateColumns; /** * The CSS `grid-template-rows` property. * * It defines the line names and track sizing functions of the grid rows. * * @see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows) */ gridTemplateRows: Property.GridTemplateRows; /** * The CSS `grid-template-areas` property. * * @see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-areas) */ gridTemplateAreas: Property.GridTemplateAreas; /** * The CSS `grid-areas` property. * * It specifies a grid item’s size and location within a grid by * contributing a line, a span, or nothing (automatic) * to its grid placement, thereby specifying the edges of its grid area. * * @see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-area) */ gridArea: Property.GridArea; /** * The CSS `grid-auto-flow` property * * It controls how the auto-placement algorithm works, * specifying exactly how auto-placed items get flowed into the grid. * * @see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-flow) */ gridAutoFlow: Property.GridAutoFlow; /** * The CSS `grid-auto-columns` property. * * It specifies the size of an implicitly-created grid column track or pattern of tracks. * * @see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-columns) */ gridAutoColumns: Property.GridAutoColumns; /** * The CSS `grid-auto-rows` property. * * It specifies the size of an implicitly-created grid row track or pattern of tracks. * * @see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-rows) */ gridAutoRows: Property.GridAutoRows; /** * The CSS `grid-column` property. * * It specifies a grid item's size and location within a grid column * by contributing a line, a span, or nothing (automatic) to its grid placement, * thereby specifying the `inline-start` and `inline-end` edge of its grid area. * * @see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column) */ gridColumn: Property.GridColumn; /** * The CSS `grid-column` property. * * It specifies a grid item’s start position within the grid column by * contributing a line, a span, or nothing (automatic) to its grid placement * * @see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column-start) */ gridColumnStart: Property.GridColumnStart; /** * The CSS `grid-column` property * * It specifies a grid item’s end position within the grid column by * contributing a line, a span, or nothing (automatic) to its grid placement, * thereby specifying the block-end edge of its grid area. * * @see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column-end) */ gridColumnEnd: Property.GridColumnEnd; /** * The CSS `grid-row` property * * It specifies a grid item’s size and location within the grid row * by contributing a line, a span, or nothing (automatic) to its grid placement, * thereby specifying the `inline-start` and `inline-end` edge of its grid area. * * @see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row) */ gridRow: Property.GridRow; /** * The CSS `grid-row-start` property * * It specifies a grid item’s start position within the grid row by * contributing a line, a span, or nothing (automatic) to its grid placement, * thereby specifying the `inline-start` edge of its grid area. * * @see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row-start) */ gridRowStart: Property.GridRowStart; /** * The CSS `grid-row-end` property * * It specifies a grid item’s end position within the grid row by * contributing a line, a span, or nothing (automatic) to its grid placement, * thereby specifying the `inline-end` edge of its grid area. * * @see [Mozilla Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row-end) */ gridRowEnd: Property.GridRowEnd; /** * The CSS `place-items` property. * * It allows you to align items along both the block and * inline directions at once (i.e. the align-items and justify-items properties) * in a relevant layout system such as `Grid` or `Flex`. * * @see [Mozilla Docs](https://developer.mozilla.org/docs/Web/CSS/place-items) */ placeItems: Property.PlaceItems; /** * The CSS `place-content` property. * * It allows you to align content along both the block and * inline directions at once (i.e. the align-content and justify-content properties) * in a relevant layout system such as Grid or Flexbox. * * @see [Mozilla Docs](https://developer.mozilla.org/docs/Web/CSS/place-content) */ placeContent: Property.PlaceContent; /** * The CSS `place-self` property. * * It allows you to align an individual item in both the block and * inline directions at once (i.e. the align-self and justify-self properties) * in a relevant layout system such as Grid or Flexbox. * * @see [Mozilla Docs](https://developer.mozilla.org/docs/Web/CSS/place-self) */ placeSelf: Property.PlaceSelf; /** * The CSS `gap` property. * * It defines the gap between items in both flex and * grid contexts. * * @see [Mozilla Docs](https://developer.mozilla.org/docs/Web/CSS/gap) */ gap: Property.Gap<SpaceScaleValue> | number; /** * The CSS `row-gap` property. * * It sets the size of the gap (gutter) between an element's grid rows. * * @see [Mozilla Docs](https://developer.mozilla.org/docs/Web/CSS/row-gap) */ rowGap: Property.RowGap<SpaceScaleValue> | number; /** * The CSS `column-gap` property. * * It sets the size of the gap (gutter) between an element's columns. * * @see [Mozilla Docs](https://developer.mozilla.org/docs/Web/CSS/column-gap) */ columnGap: Property.ColumnGap<SpaceScaleValue> | number; }>; /** * Style prop names used in CSS grid based components */ export declare const gridLayoutPropNames: KeysOf<GridLayoutProps>; //# sourceMappingURL=grid.d.ts.map