diff --git a/types/styled-system/dist/space.d.ts b/types/styled-system/dist/space.d.ts index b3996a559c..9165ff39a7 100644 --- a/types/styled-system/dist/space.d.ts +++ b/types/styled-system/dist/space.d.ts @@ -1,22 +1,46 @@ export type ResponsiveValue = T | Array; export type SpaceValue = number | string; + +/** + * Converts shorthand margin and padding props to margin and padding CSS declarations + * + * - Numbers from 0-4 (or the length of theme.space) are converted to values on the spacing scale. + * - Negative values can be used for negative margins. + * - Numbers greater than the length of the theme.space array are converted to raw pixel values. + * - String values are passed as raw CSS values. + * - Array values are converted into responsive values. + */ export type ResponsiveSpaceValue = ResponsiveValue; export interface SpaceProps { + /** Margin on top, left, bottom and right */ m?: ResponsiveSpaceValue; + /** Margin for the top */ mt?: ResponsiveSpaceValue; + /** Margin for the right */ mr?: ResponsiveSpaceValue; + /** Margin for the bottom */ mb?: ResponsiveSpaceValue; + /** Margin for the left */ ml?: ResponsiveSpaceValue; + /** Margin for the left and right */ mx?: ResponsiveSpaceValue; + /** Margin for the top and bottom */ my?: ResponsiveSpaceValue; + /** Padding on top, left, bottom and right */ p?: ResponsiveSpaceValue; + /** Padding for the top */ pt?: ResponsiveSpaceValue; + /** Padding for the right */ pr?: ResponsiveSpaceValue; + /** Padding for the bottom */ pb?: ResponsiveSpaceValue; + /** Padding for the left */ pl?: ResponsiveSpaceValue; + /** Padding for the left and right */ px?: ResponsiveSpaceValue; + /** Padding for the top and bottom */ py?: ResponsiveSpaceValue; } diff --git a/types/styled-system/dist/styles.d.ts b/types/styled-system/dist/styles.d.ts index 224b9a9392..a06a923d11 100644 --- a/types/styled-system/dist/styles.d.ts +++ b/types/styled-system/dist/styles.d.ts @@ -21,6 +21,15 @@ export type FontSizeValue = number | string; export type ResponsiveFontSizeValue = ResponsiveValue; export interface FontSizeProps { + /** + * The fontSize utility parses a component's `fontSize` prop and converts it into a CSS font-size declaration. + * + * - Numbers from 0-8 (or `theme.fontSizes.length`) are converted to values on the [font size scale](#default-theme). + * - Numbers greater than `theme.fontSizes.length` are converted to raw pixel values. + * - String values are passed as raw CSS values. + * - And array values are converted into responsive values. + * + */ fontSize?: ResponsiveFontSizeValue; } @@ -33,12 +42,30 @@ export type ColorValue = string; export type ResponsiveColorValue = ResponsiveValue; export interface TextColorProps { + /** + * The color utility parses a component's `color` and `bg` props and converts them into CSS declarations. + * By default the raw value of the prop is returned. + * + * Color palettes can be configured with the ThemeProvider to use keys as prop values, with support for dot notation. + * Array values are converted into responsive values. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/color) + */ color?: ResponsiveColorValue; } export function textColor(...args: any[]): any; export interface BgColorProps { + /** + * The color utility parses a component's `color` and `bg` props and converts them into CSS declarations. + * By default the raw value of the prop is returned. + * + * Color palettes can be configured with the ThemeProvider to use keys as prop values, with support for dot notation. + * Array values are converted into responsive values. + * + * [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) + */ bg?: ResponsiveColorValue; } @@ -71,6 +98,11 @@ export type TextAlignValue = export type ResponsiveTextAlignValue = ResponsiveValue; export interface TextAlignProps { + /** + * The text-align CSS property specifies the horizontal alignment of an inline or table-cell box. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/text-align) + */ textAlign?: ResponsiveTextAlignValue; } @@ -79,6 +111,14 @@ export function textAlign(...args: any[]): any; export type LineHeightValue = number | string; export type ResponsiveLineHeightValue = ResponsiveValue; export interface LineHeightProps { + /** + * The line-height CSS property sets the amount of space used for lines, such as in text. On block-level elements, + * it specifies the minimum height of line boxes within the element. + * + * On non-replaced inline elements, it specifies the height that is used to calculate line box height. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/line-height) + */ lineHeight?: ResponsiveLineHeightValue; } export function lineHeight(...args: any[]): any; @@ -93,6 +133,13 @@ export type FontWeightValue = export type ResponsiveFontWeightValue = ResponsiveValue; export interface FontWeightProps { + /** + * The font-weight CSS property specifies the weight (or boldness) of the font. + * + * The font weights available to you will depend on the font-family you are using. Some fonts are only available in normal and bold. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight) + */ fontWeight?: ResponsiveFontWeightValue; } @@ -101,6 +148,12 @@ export function fontWeight(...args: any[]): any; export type FontStyleValue = string; export type ResponsiveFontStyleValue = ResponsiveValue; export interface FontStyleProps { + /** + * The font-style CSS property specifies whether a font should be styled with a normal, italic, + * or oblique face from its font-family. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/font-style) + */ fontStyle?: ResponsiveFontStyleValue; } export function fontStyle(...args: any[]): any; @@ -108,6 +161,11 @@ export function fontStyle(...args: any[]): any; export type LetterSpacingValue = number | string; export type ResponsiveLetterSpacingValue = ResponsiveValue; export interface LetterSpacingProps { + /** + * The letter-spacing CSS property sets the spacing behavior between text characters. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/letter-spacing) + */ letterSpacing?: ResponsiveLetterSpacingValue; } export function letterSpacing(...args: any[]): any; @@ -126,47 +184,94 @@ export type DisplayValue = | "inline-block"; export type ResponsiveDisplayValue = ResponsiveValue; export interface DisplayProps { + /** + * The display CSS property defines the display type of an element, which consists of the two basic qualities + * of how an element generates boxes — the outer display type defining how the box participates in flow layout, + * and the inner display type defining how the children of the box are laid out. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/display) + */ display?: ResponsiveDisplayValue; } export function display(...args: any[]): any; export interface MaxWidthProps { + /** + * The max-width CSS property sets the maximum width of an element. + * It prevents the used value of the width property from becoming larger than the value specified by max-width. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/max-width) + */ maxWidth?: ResponsiveSpaceValue; } export function maxWidth(...args: any[]): any; export interface MinWidthProps { + /** + * The min-width CSS property sets the minimum width of an element. + * It prevents the used value of the width property from becoming smaller than the value specified for min-width. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/min-width) + */ minWidth?: ResponsiveSpaceValue; } export function minWidth(...args: any[]): any; export interface WidthProps { + /** + * The width utility parses a component's `width` prop and converts it into a CSS width declaration. + * + * - Numbers from 0-1 are converted to percentage widths. + * - Numbers greater than 1 are converted to pixel values. + * - String values are passed as raw CSS values. + * - And arrays are converted to responsive width styles. + */ width?: ResponsiveSpaceValue; } export function width(...args: any[]): any; export interface MaxHeightProps { + /** + * The max-height CSS property sets the maximum height of an element. It prevents the used value of the height + * property from becoming larger than the value specified for max-height. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/max-height) + */ maxHeight?: ResponsiveSpaceValue; } export function maxHeight(...args: any[]): any; export interface MinHeightProps { + /** + * The min-height CSS property sets the minimum height of an element. It prevents the used value of the height + * property from becoming smaller than the value specified for min-height. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/display) + */ minHeight?: ResponsiveSpaceValue; } export function minHeight(...args: any[]): any; export interface HeightProps { + /** + * The height CSS property specifies the height of an element. By default, the property defines the height of the + * content area. If box-sizing is set to border-box, however, it instead determines the height of the border area. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/height) + */ height?: ResponsiveSpaceValue; } export function height(...args: any[]): any; +// TODO: Document, I couldn't find any info on these two properties... + export interface SizeWidthProps { size?: ResponsiveSpaceValue; } @@ -187,6 +292,9 @@ export type RatioValue = SpaceValue; export type ResponsiveRatioValue = ResponsiveValue; export interface RatioProps { + /** + * The ration is height: 0 & paddingBottom + */ ratio?: ResponsiveRatioValue; } @@ -206,6 +314,11 @@ export type VerticalAlignValue = export type ResponsiveVerticalAlignValue = ResponsiveValue; export interface VerticalAlignProps { + /** + * The vertical-align CSS property specifies sets vertical alignment of an inline or table-cell box. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/vertical-align) + */ verticalAlign?: ResponsiveVerticalAlignValue; } @@ -235,6 +348,15 @@ export type AlignItemsValue = export type ResponsiveAlignItemsValue = ResponsiveValue; export interface AlignItemsProps { + /** + * The CSS align-items property sets the align-self value on all direct children as a group. The align-self + * property sets the alignment of an item within its containing block. + * + * In Flexbox it controls the alignment of items on the Cross Axis, in Grid Layout it controls the alignment + * of items on the Block Axis within their grid area. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items) + */ alignItems?: ResponsiveAlignItemsValue; } @@ -260,6 +382,12 @@ export type AlignContentValue = export type ResponsiveAlignContentValue = ResponsiveValue; export interface AlignContentProps { + /** + * The CSS align-content property sets how the browser distributes space between and around content items + * along the cross-axis of a flexbox container, and the main-axis of a grid container. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content) + */ alignContent?: ResponsiveAlignContentValue; } @@ -269,6 +397,12 @@ export type JustifyItemsValue = string; export type ResponsiveJustifyItemsValue = ResponsiveValue; export interface JustifyItemsProps { + /** + * The CSS justify-items property defines the default justify-self for all items of the box, giving them all + * a default way of justifying each box along the appropriate axis. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items) + */ justifyItems?: ResponsiveJustifyItemsValue; } @@ -294,6 +428,12 @@ export type ResponsiveJustifyContentValue = ResponsiveValue< >; export interface JustifyContentProps { + /** + * The CSS justify-content property defines how the browser distributes space between and around content items + * along the main-axis of a flex container, and the inline axis of a grid container. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content) + */ justifyContent?: ResponsiveJustifyContentValue; } @@ -303,6 +443,12 @@ export type FlexWrapValue = "nowrap" | "wrap" | "wrap-reverse"; export type ResponsiveFlexWrapValue = ResponsiveValue; export interface FlexWrapProps { + /** + * The flex-wrap CSS property sets whether flex items are forced onto one line or can wrap onto multiple lines. + * If wrapping is allowed, it sets the direction that lines are stacked. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/flex-wrap) + */ flexWrap?: ResponsiveFlexWrapValue; } @@ -338,6 +484,12 @@ export type FlexDirectionValue = export type ResponsiveFlexDirectionValue = ResponsiveValue; export interface FlexDirectionProps { + /** + * The flex-direction CSS property specifies how flex items are placed in the flex container defining the main + * axis and the direction (normal or reversed). + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/flex-direction) + */ flexDirection?: ResponsiveFlexDirectionValue; } @@ -347,6 +499,12 @@ export type FlexValue = number | string; export type ResponsiveFlexValue = ResponsiveValue; export interface FlexProps { + /** + * The flex CSS property specifies how a flex item will grow or shrink so as to fit the space available in + * its flex container. This is a shorthand property that sets flex-grow, flex-shrink, and flex-basis. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/flex) + */ flex?: ResponsiveFlexValue; } @@ -375,6 +533,12 @@ export type JustifySelfValue = export type ResponsiveJustifySelfValue = ResponsiveValue; export interface JustifySelfProps { + /** + * The CSS justify-self property set the way a box is justified inside its alignment container along + * the appropriate axis. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-self) + */ justifySelf?: ResponsiveJustifySelfValue; } @@ -401,6 +565,14 @@ export type AlignSelfValue = export type ResponsiveAlignSelfValue = ResponsiveValue; export interface AlignSelfProps { + /** + * The align-self CSS property aligns flex items of the current flex line overriding the align-items value. + * + * If any of the item's cross-axis margin is set to auto, then align-self is ignored. In Grid layout align-self + * aligns the item inside the grid area. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/align-self) + */ alignSelf?: ResponsiveAlignSelfValue; } @@ -410,6 +582,12 @@ export type OrderValue = GlobalStyleValues | number; export type ResponsiveOrderValue = ResponsiveValue; export interface OrderProps { + /** + * The order CSS property sets the order to lay out an item in a flex or grid container. Items in a container + * are sorted by ascending order value and then by their source code order. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/order) + */ order?: ResponsiveOrderValue; } @@ -423,18 +601,40 @@ export type GridGapValue = number | string; export type ResponsiveGridGapValue = ResponsiveValue; export interface GridGapProps { + /** + * The gap CSS property sets the gaps (gutters) between rows and columns. It is a shorthand for row-gap + * and column-gap. + * + * @deprecated use gap + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/gap) + */ gridGap?: ResponsiveGridGapValue; } export function gridGap(...args: any[]): any; export interface GridColumnGapProps { + /** + * The column-gap CSS property sets the size of the gap (gutter) between an element's columns. + * + * @deprecated use column-gap + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/column-gap) + */ gridColumnGap?: ResponsiveGridGapValue; } export function gridColumnGap(...args: any[]): any; export interface GridRowGapProps { + /** + * The row-gap CSS property sets the size of the gap (gutter) between an element's rows. + * + * @deprecated use row-gap + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/row-gap) + */ gridRowGap?: ResponsiveGridGapValue; } @@ -444,12 +644,26 @@ export type GridCellValue = string; export type ResponsiveGridCellValue = ResponsiveValue; export interface GridColumnProps { + /** + * The grid-column CSS property is a shorthand property for grid-column-start and grid-column-end specifying + * a grid item's size and location within the 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. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column) + */ gridColumn?: ResponsiveGridCellValue; } export function gridColumn(...args: any[]): any; export interface GridRowProps { + /** + * The grid-row CSS property is a shorthand property for grid-row-start and grid-row-end specifying 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. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row) + */ gridRow?: ResponsiveGridCellValue; } @@ -459,18 +673,34 @@ export type GridAutoValue = string; export type ResponsiveGridAutoValue = ResponsiveValue; export interface GridAutoFlowProps { + /** + * The grid-auto-flow CSS property controls how the auto-placement algorithm works, specifying exactly + * how auto-placed items get flowed into the grid. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-flow) + */ gridAutoFlow?: ResponsiveGridAutoValue; } export function gridAutoFlow(...args: any[]): any; export interface GridAutoColumnsProps { + /** + * The grid-auto-columns CSS property specifies the size of an implicitly-created grid column track. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-columns) + */ gridAutoColumns?: ResponsiveGridAutoValue; } export function gridAutoColumns(...args: any[]): any; export interface GridAutoRowsProps { + /** + * The grid-auto-rows CSS property specifies the size of an implicitly-created grid row track. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-rows) + */ gridAutoRows?: ResponsiveGridAutoValue; } @@ -480,24 +710,46 @@ export type GridTemplateValue = string; export type ResponsiveGridTemplateValue = ResponsiveValue; export interface GridTemplatesColumnsProps { + /** + * The grid-template-columns CSS property defines the line names and track sizing functions of the grid columns. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns) + */ gridTemplateColumns?: ResponsiveGridTemplateValue; } export function gridTemplateColumns(...args: any[]): any; export interface GridTemplatesRowsProps { + /** + * The grid-template-rows CSS property defines the line names and track sizing functions of the grid rows. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/row-template-rows) + */ gridTemplateRows?: ResponsiveGridTemplateValue; } export function gridTemplateRows(...args: any[]): any; export interface GridTemplatesAreasProps { + /** + * The grid-template-areas CSS property specifies named grid areas. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-areas) + */ gridTemplateAreas?: ResponsiveGridTemplateValue; } export function gridTemplateAreas(...args: any[]): any; export interface GridAreaProps { + /** + * The grid-area CSS property is a shorthand property for grid-row-start, grid-column-start, grid-row-end + * and grid-column-end, specifying 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 edges of its grid area. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-area) + */ gridArea?: ResponsiveGridTemplateValue; } @@ -511,30 +763,60 @@ export type BorderValue = string | number; export type ResponsiveBorderValue = ResponsiveValue; export interface BorderProps { + /** + * The border CSS property sets an element's border. It's a shorthand for border-width, border-style, + * and border-color. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/border) + */ border?: ResponsiveBorderValue; } export function border(...args: any[]): any; export interface BorderTopProps { + /** + * The border-top CSS property is a shorthand that sets the values of border-top-width, border-top-style, + * and border-top-color. These properties describe an element's top border. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/border-top) + */ borderTop?: ResponsiveBorderValue; } export function borderTop(...args: any[]): any; export interface BorderRightProps { + /** + * The border-right CSS property is a shorthand that sets border-right-width, border-right-style, + * and border-right-color. These properties set an element's right border. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/border-right) + */ borderRight?: ResponsiveBorderValue; } export function borderRight(...args: any[]): any; export interface BorderBottomProps { + /** + * The border-bottom CSS property sets an element's bottom border. It's a shorthand for + * border-bottom-width, border-bottom-style and border-bottom-color. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/border-bottom) + */ borderBottom?: ResponsiveBorderValue; } export function borderBottom(...args: any[]): any; export interface BorderLeftProps { + /** + * The border-left CSS property is a shorthand that sets the values of border-left-width, + * border-left-style, and border-left-color. These properties describe an element's left border. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/border-left) + */ borderLeft?: ResponsiveBorderValue; } @@ -548,6 +830,11 @@ export type BorderColorValue = string; export type ResponsiveBorderColorValue = ResponsiveValue; export interface BorderColorProps { + /** + * The border-color shorthand CSS property sets the color of all sides of an element's border. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/border-color) + */ borderColor?: ResponsiveBorderColorValue; } @@ -557,6 +844,12 @@ export type BorderRadiusValue = string | number; export type ResponsiveBorderRadiusValue = ResponsiveValue; export interface BorderRadiusProps { + /** + * The border-radius CSS property rounds the corners of an element's outer border edge. You can set a single + * radius to make circular corners, or two radii to make elliptical corners. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/border-radius) + */ borderRadius?: ResponsiveBorderRadiusValue; } @@ -566,6 +859,13 @@ export type BoxShadowValue = string | number; export type ResponsiveBoxShadowValue = ResponsiveValue; export interface BoxShadowProps { + /** + * The box-shadow CSS property adds shadow effects around an element's frame. You can set multiple effects + * separated by commas. A box shadow is described by X and Y offsets relative to the element, blur and spread + * radii, and color. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/box-shadow) + */ boxShadow?: ResponsiveBoxShadowValue; } @@ -575,6 +875,12 @@ export type OpacityValue = string | number; export type ResponsiveOpacityValue = ResponsiveValue; export interface OpacityProps { + /** + * The opacity CSS property sets the transparency of an element or the degree to which content + * behind an element is visible. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity) + */ opacity?: ResponsiveOpacityValue; } @@ -584,6 +890,12 @@ export type OverflowValue = string | number; export type ResponsiveOverflowValue = ResponsiveValue; export interface OverflowProps { + /** + * The overflow CSS property sets what to do when an element's content is too big to fit in its block + * formatting context. It is a shorthand for overflow-x and overflow-y. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/overflow) + */ overflow?: ResponsiveOverflowValue; } @@ -596,6 +908,12 @@ export type BackgroundValue = string; export type ResponsiveBackgroundValue = ResponsiveValue; export interface BackgroundProps { + /** + * The background shorthand CSS property sets all background style properties at once, + * such as color, image, origin and size, repeat method, and others. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background) + */ background?: ResponsiveBackgroundValue; } @@ -605,6 +923,11 @@ export type BackgroundImageValue = string; export type ResponsiveBackgroundImageValue = ResponsiveValue; export interface BackgroundImageProps { + /** + * The background-image CSS property sets one or more background images on an element. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background-image) + */ backgroundImage?: ResponsiveBackgroundImageValue; } @@ -614,6 +937,12 @@ export type BackgroundSizeValue = string; export type ResponsiveBackgroundSizeValue = ResponsiveValue; export interface BackgroundSizeProps { + /** + * The background-size CSS property sets the size of the element's background image. The + * image can be left to its natural size, stretched, or constrained to fit the available space. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background-size) + */ backgroundSize?: ResponsiveBackgroundSizeValue; } @@ -623,6 +952,12 @@ export type BackgroundPositionValue = string; export type ResponsiveBackgroundPositionValue = ResponsiveValue; export interface BackgroundPositionProps { + /** + * The background-position CSS property sets the initial position for each background image. The + * position is relative to the position layer set by background-origin. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background-position) + */ backgroundPosition?: ResponsiveBackgroundPositionValue; } @@ -632,6 +967,12 @@ export type BackgroundRepeatValue = string; export type ResponsiveBackgroundRepeatValue = ResponsiveValue; export interface BackgroundRepeatProps { + /** + * The background-repeat CSS property sets how background images are repeated. A background + * image can be repeated along the horizontal and vertical axes, or not repeated at all. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background-repeat) + */ backgroundRepeat?: ResponsiveBackgroundRepeatValue; } @@ -650,6 +991,12 @@ export type PositionValue = export type ResponsivePositionValue = ResponsiveValue; export interface PositionProps { + /** + * The position CSS property specifies how an element is positioned in a document. + * The top, right, bottom, and left properties determine the final location of positioned elements. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/position) + */ position?: ResponsivePositionValue; } @@ -659,6 +1006,12 @@ export type ZIndexValue = GlobalStyleValues | "auto" | number; export type ResponsiveZIndexValue = ResponsiveValue; export interface ZIndexProps { + /** + * The z-index CSS property sets the z-order of a positioned element and its descendants or + * flex items. Overlapping elements with a larger z-index cover those with a smaller one. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/z-index) + */ zIndex?: ZIndexValue; } @@ -668,6 +1021,12 @@ export type TopValue = string | number; export type ResponsiveTopValue = ResponsiveValue; export interface TopProps { + /** + * The top CSS property participates in specifying the vertical position of a + * positioned element. It has no effect on non-positioned elements. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/top) + */ top?: ResponsiveTopValue; } @@ -677,6 +1036,12 @@ export type RightValue = string | number; export type ResponsiveRightValue = ResponsiveValue; export interface RightProps { + /** + * The right CSS property participates in specifying the horizontal position of a + * positioned element. It has no effect on non-positioned elements. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/right) + */ right?: ResponsiveRightValue; } @@ -686,6 +1051,12 @@ export type BottomValue = string | number; export type ResponsiveBottomValue = ResponsiveValue; export interface BottomProps { + /** + * The bottom CSS property participates in specifying the vertical position of a + * positioned element. It has no effect on non-positioned elements. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/top) + */ bottom?: ResponsiveBottomValue; } @@ -695,6 +1066,12 @@ export type LeftValue = string | number; export type ResponsiveLeftValue = ResponsiveValue; export interface LeftProps { + /** + * The left CSS property participates in specifying the horizontal position + * of a positioned element. It has no effect on non-positioned elements. + * + * [MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/left) + */ left?: ResponsiveLeftValue; }