Skip to content

Latest commit

 

History

History
241 lines (149 loc) · 5.94 KB

README.md

File metadata and controls

241 lines (149 loc) · 5.94 KB
Raw

reflexion

reflexion

Table of contents

Type Aliases

Functions

Type Aliases

Alignment

Ƭ Alignment: "top-left" | "top-center" | "top-right" | "left" | "center" | "right" | "bottom-left" | "bottom-center" | "bottom-right"

Defined in

lib/types.ts:5

Dimension

Ƭ Dimension: "hug" | "fill" | string | number

Defined in

lib/types.ts:16

Direction

Ƭ Direction: "vertical" | "horizontal"

Defined in

lib/types.ts:3

FlexProps

Ƭ FlexProps: Object

Type declaration

Name Type Description
align? Alignment Element container setting that sets the alignment of its children. If set, the element is considered to be a container.
class? string Element classes.
className? string -
direction? Direction Element container setting that sets the flow direction of the children. If set, the element is considered to be a container.
gap? Gap Element container setting that set the gap betwen its children. If set to "auto", the gap is evenly distributed between the children.
height? Dimension Element height. If set to "fill", the element vertically fills the parent container. If set to "hug", it hugs the content of its children.
overflow? "hidden" | "auto" Element overflow setting. Controlled by the scroll property.
scroll? boolean Element container setting that enables scrolling if its content goes out of bounds.
style? JSX.AllCSSProperties Element styles. These override any style abstracted by the other properties.
width? Dimension Element width. If set to "fill", the element horizontally fills the parent container. If set to "hug", it hugs the content of its children.
wrap? boolean Element container setting that sets whether containing items should wrap or not.

Defined in

lib/types.ts:20

Gap

Ƭ Gap: "auto" | number | string

Defined in

lib/types.ts:18

Functions

Flex

▸ Flex(props, context?): null | VNode<any>

Creates a div element with abstracted CSS Flexbox properties.

Parameters

Name Type
props RenderableProps<PropsWithoutRef<FlexProps & DOMAttributes<HTMLDivElement>> & {}, any>
context? any

Returns

null | VNode<any>

Defined in

node_modules/preact/src/index.d.ts:90

adjustGap

▸ adjustGap(style, gap): null | object

Parameters

Name Type
style null | object
gap undefined | Gap

Returns

null | object

Defined in

lib/tools/adjustGap.ts:3

alignFlex

▸ alignFlex(align, direction): Object

Parameters

Name Type
align Alignment
direction Direction

Returns

Object

Name Type
alignItems string
justifyContent string

Defined in

lib/tools/alignFlex.ts:3

flex

▸ flex(direction, wrap, align, overflow, gap, width?, height?): Object

Parameters

Name Type
direction undefined | Direction
wrap boolean
align undefined | Alignment
overflow undefined | "auto" | "hidden"
gap undefined | Gap
width? Dimension
height? Dimension

Returns

Object

Name Type
display undefined | string
flexDirection undefined | string
height undefined | Dimension
overflow undefined | "auto" | "hidden"
width undefined | Dimension
wrap string

Defined in

lib/tools/flex.ts:7

flexDirection

▸ flexDirection(direction): "row" | "column"

Parameters

Name Type
direction Direction

Returns

"row" | "column"

Defined in

lib/tools/flexDirection.ts:3

merge

▸ merge<A, B>(a, b?): A | A & B

Type parameters

Name Type
A extends object
B extends object

Parameters

Name Type
a A
b? B

Returns

A | A & B

Defined in

lib/tools/merge.ts:1