Flex items’s UIView.

Declaration

publicletview:UIView

Item natural size, considering only properties of the view itself. Independent of the item frame.

Declaration

publicvarintrinsicSize:CGSize

This method adds a flex item (UIView) to a flex container. Internally the methods adds the UIView has subviews and enables flexbox.

Declaration

publicfuncaddItem()->Flex

Return Value

The added view flex interface

This method is similar toaddItem(: UIView) except that it also creates the flex item’s UIView. Internally the method creates anUIView, adds it has subviews and enables flexbox. This is useful to add a flex item/container easily when you don’t need to refer to it later.

Declaration

publicfuncaddItem(_view:UIView)->Flex

Parameters

Return Value

The added view flex interface

This method is used to structure your code so that it matches the flexbox structure. The method has a closure parameter with asingle parameter calledflex. This parameter is in fact, the view’s flex interface, it can be used to adds other flex itemsand containers.

Declaration

publicfuncdefine(_closure:(_flex:Flex)->Void)->Flex

Parameters

Return Value

Flex interface

The method layout the flex container’s children

Declaration

publicfunclayout(mode:LayoutMode=.fitContainer)

Parameters

This property controls dynamically if a flexbox’s UIView is included or not in the flexbox layouting. When aflexbox’s UIView is excluded, FlexLayout won’t layout the view and its children views.

Declaration

publicvarisIncludedInLayout:Bool=true

This method controls dynamically if a flexbox’s UIView is included or not in the flexbox layouting. When aflexbox’s UIView is excluded, FlexLayout won’t layout the view and its children views.

Declaration

publicfuncisIncludedInLayout(_included:Bool)->Flex

Parameters

Return Value

The framework is so highly optimized, that flex item are layouted only when a flex property is changed and when flex containersize change. In the event that you want to force FlexLayout to do a layout of a flex item, you can mark it as dirty usingmarkDirty().

Dirty flag propagates to the root of the flexbox tree ensuring that when any item is invalidated its whole subtree will be re-calculated

Declaration

publicfuncmarkDirty()->Flex

Return Value

Flex interface

Returns the item size when layouted in the specified frame size

Declaration

publicfuncsizeThatFits(size:CGSize)->CGSize

Parameters

Return Value

item size

Thedirection property establishes the main-axis, thus defining the direction flex items are placed in the flex container.

Thedirection property specifies how flex items are laid out in the flex container, by setting the direction of the flex container’s main axis. They can be laid out in two main directions, like columns vertically or like rows horizontally.

Note that row and row-reverse are affected by the layout direction (seelayoutDirection property) of the flex container. If its text direction is LTR (left to right), row represents the horizontal axis oriented from left to right, and row-reverse from right to left; if the direction is rtl, it’s the opposite.

Declaration

publicfuncdirection(_value:Direction)->Flex

Parameters

Thewrap property controls whether the flex container is single-lined or multi-lined, and the direction of the cross-axis, which determines the direction in which the new lines are stacked in.

Declaration

publicfuncwrap(_value:Wrap)->Flex

Parameters

Direction defaults to Inherit on all nodes except the root which defaults to LTR. It is up to you to detect the user’s preferred direction (most platforms have a standard way of doing this) and setting this direction on the root of your layout tree.

Declaration

publicfunclayoutDirection(_value:LayoutDirection)->Flex

Parameters

Return Value

ThejustifyContent property defines the alignment along the main-axis of the current line of the flex container. It helps distribute extra free space leftover when either all the flex items on a line have reached their maximum size. For example, if children are flowing vertically,justifyContent controls how they align vertically.

Declaration

publicfuncjustifyContent(_value:JustifyContent)->Flex

Parameters

ThealignItems property defines how flex items are laid out along the cross axis on the current line.Similar tojustifyContent but for the cross-axis (perpendicular to the main-axis). For example, ifchildren are flowing vertically,alignItems controls how they align horizontally.

Declaration

publicfuncalignItems(_value:AlignItems)->Flex

Parameters

ThealignSelf property controls how a child aligns in the cross direction, overriding thealignItemsof the parent. For example, if children are flowing vertically,alignSelf will control how the flex item will align horizontally.

Declaration

publicfuncalignSelf(_value:AlignSelf)->Flex

Parameters

The align-content property aligns a flex container’s lines within the flex container when there is extra spacein the cross-axis, similar to how justifyContent aligns individual items within the main-axis.

Declaration

publicfuncalignContent(_value:AlignContent)->Flex

Parameters

Thegrow property defines the ability for a flex item to grow if necessary. It accepts a unitless value that serves as a proportion. It dictates what amount of the available space inside the flex container the item should take up.

Declaration

publicfuncgrow(_value:CGFloat)->Flex

Parameters

It specifies theflex shrink factor, which determines how much the flex item will shrink relative to the rest of the flex items in the flex container when there isn’t enough space on the main-axis.

When omitted, it is set to 0 and the flex shrink factor is multiplied by the flexbasis when distributing negative space.

A shrink value of 0 keeps the view’s size in the main-axis direction. Note that this may cause the view to overflow its flex container.

Declaration

publicfuncshrink(_value:CGFloat)->Flex

Parameters

This property takes the same values as the width and height properties, and specifies the initial size of theflex item, before free space is distributed according to the grow and shrink factors.

Specifyingnil set the basis asauto, which means the length is equal to the length of the item. If the item has no length specified, the length will be according to its content.

Declaration

publicfuncbasis(_value:CGFloat?)->Flex

Parameters

The value specifies the view’s width in pixels. The value must be non-negative.

Declaration

publicfuncwidth(_value:CGFloat?)->Flex

The value specifies the view’s width in percentage of its container width. The value must be non-negative.Example: view.flex.width(20%)

Declaration

publicfuncwidth(_percent:FPercent)->Flex

The value specifies the view’s height in pixels. The value must be non-negative.

Declaration

publicfuncheight(_value:CGFloat?)->Flex

The value specifies the view’s height in percentage of its container height. The value must be non-negative.Example: view.flex.height(40%)

Declaration

publicfuncheight(_percent:FPercent)->Flex

The value specifies view’s width and the height in pixels. Values must be non-negative.

Declaration

publicfuncsize(_size:CGSize?)->Flex

The value specifies the width and the height of the view in pixels, creating a square view. Values must be non-negative.

Declaration

publicfuncsize(_sideLength:CGFloat)->Flex

The value specifies the view’s minimum width in pixels. The value must be non-negative.

Declaration

publicfuncminWidth(_value:CGFloat?)->Flex

The value specifies the view’s minimum width in percentage of its container width. The value must be non-negative.

Declaration

publicfuncminWidth(_percent:FPercent)->Flex

The value specifies the view’s maximum width in pixels. The value must be non-negative.

Declaration

publicfuncmaxWidth(_value:CGFloat?)->Flex

The value specifies the view’s maximum width in percentage of its container width. The value must be non-negative.

Declaration

publicfuncmaxWidth(_percent:FPercent)->Flex

The value specifies the view’s minimum height in pixels. The value must be non-negative.

Declaration

publicfuncminHeight(_value:CGFloat?)->Flex

The value specifies the view’s minimum height in percentage of its container height. The value must be non-negative.

Declaration

publicfuncminHeight(_percent:FPercent)->Flex

The value specifies the view’s maximum height in pixels. The value must be non-negative.

Declaration

publicfuncmaxHeight(_value:CGFloat?)->Flex

The value specifies the view’s maximum height in percentage of its container height. The value must be non-negative.

Declaration

publicfuncmaxHeight(_percent:FPercent)->Flex

AspectRatio is a property introduced by Yoga that don’t exist in CSS. AspectRatio solves the problem of knowing one dimension of an element and an aspect ratio, this is very common when it comes to images, videos, and othermedia types. AspectRatio accepts any floating point value > 0, the default is undefined.

Declaration

publicfuncaspectRatio(_value:CGFloat?)->Flex

Parameters

Return Value

AspectRatio is a property introduced by Yoga that don’t exist in CSS. AspectRatio solves the problem of knowingone dimension of an element and an aspect ratio, this is very common when it comes to images, videos, and othermedia types. AspectRatio accepts any floating point value > 0, the default is undefined.

Declaration

publicfuncaspectRatio(ofimageView:UIImageView)->Flex

Parameters

Return Value

The position property tells Flexbox how you want your item to be positioned within its parent.

Declaration

publicfuncposition(_value:Position)->Flex

Parameters

Set the left edge distance from the container left edge in pixels.

Declaration

publicfuncleft(_value:CGFloat)->Flex

Set the top edge distance from the container top edge in pixels.

Declaration

publicfunctop(_value:CGFloat)->Flex

Set the right edge distance from the container right edge in pixels.

Declaration

publicfuncright(_value:CGFloat)->Flex

Set the bottom edge distance from the container bottom edge in pixels.

Declaration

publicfuncbottom(_value:CGFloat)->Flex

Set the start edge (LTR=left, RTL=right) distance from the container start edge in pixels.

Declaration

publicfuncstart(_value:CGFloat)->Flex

Set the end edge (LTR=right, RTL=left) distance from the container start edge in pixels.

Declaration

publicfuncend(_value:CGFloat)->Flex

Set the top margin. Top margin specify the offset the top edge of the item should have from from it’s closest sibling (item) or parent (container).

Declaration

publicfuncmarginTop(_value:CGFloat)->Flex

Undocumented

Declaration

publicfuncmarginTop(_percent:FPercent)->Flex

Set the left margin. Left margin specify the offset the left edge of the item should have from from it’s closest sibling (item) or parent (container).

Declaration

publicfuncmarginLeft(_value:CGFloat)->Flex

Undocumented

Declaration

publicfuncmarginLeft(_percent:FPercent)->Flex

Set the bottom margin. Bottom margin specify the offset the bottom edge of the item should have from from it’s closest sibling (item) or parent (container).

Declaration

publicfuncmarginBottom(_value:CGFloat)->Flex

Undocumented

Declaration

publicfuncmarginBottom(_percent:FPercent)->Flex

Set the right margin. Right margin specify the offset the right edge of the item should have from from it’s closest sibling (item) or parent (container).

Declaration

publicfuncmarginRight(_value:CGFloat)->Flex

Undocumented

Declaration

publicfuncmarginRight(_percent:FPercent)->Flex

Set the start margin.

Depends on the itemLayoutDirection:

• In LTR direction, start margin specify the offset theleft edge of the item should have from from it’s closest sibling (item) or parent (container).
• IN RTL direction, start margin specify the offset theright edge of the item should have from from it’s closest sibling (item) or parent (container).

Declaration

publicfuncmarginStart(_value:CGFloat)->Flex

Undocumented

Declaration

publicfuncmarginStart(_percent:FPercent)->Flex

Set the end margin.

Depends on the itemLayoutDirection:

• In LTR direction, end margin specify the offset theright edge of the item should have from from it’s closest sibling (item) or parent (container).
• IN RTL direction, end margin specify the offset theleft edge of the item should have from from it’s closest sibling (item) or parent (container).

Declaration

publicfuncmarginEnd(_value:CGFloat)->Flex

Undocumented

Declaration

publicfuncmarginEnd(_percent:FPercent)->Flex

Set the left, right, start and end margins to the specified value.

Declaration

publicfuncmarginHorizontal(_value:CGFloat)->Flex

Undocumented

Declaration

publicfuncmarginHorizontal(_percent:FPercent)->Flex

Set the top and bottom margins to the specified value.

Declaration

publicfuncmarginVertical(_value:CGFloat)->Flex

Undocumented

Declaration

publicfuncmarginVertical(_percent:FPercent)->Flex

Set all margins using UIEdgeInsets.This method is particularly useful to set all margins using iOS 11UIView.safeAreaInsets.

Declaration

publicfuncmargin(_insets:UIEdgeInsets)->Flex

Set all margins to the specified value.

Declaration

publicfuncmargin(_value:CGFloat)->Flex

Undocumented

Declaration

publicfuncmargin(_percent:FPercent)->Flex

Set the individually top, left, bottom and right margins.

Declaration

publicfuncmargin(_top:CGFloat,_left:CGFloat,_bottom:CGFloat,_right:CGFloat)->Flex

Undocumented

Declaration

publicfuncmargin(_top:FPercent,_left:FPercent,_bottom:FPercent,_right:FPercent)->Flex

Set the top padding. Top padding specify theoffset children should have from the container’s top edge.

Declaration

publicfuncpaddingTop(_value:CGFloat)->Flex

Set the left padding. Left padding specify theoffset children should have from the container’s left edge.

Declaration

publicfuncpaddingLeft(_value:CGFloat)->Flex

Set the bottom padding. Bottom padding specify theoffset children should have from the container’s bottom edge.

Declaration

publicfuncpaddingBottom(_value:CGFloat)->Flex

Set the top padding. Top padding specify theoffset children should have from the container’s top edge.

Declaration

publicfuncpaddingRight(_value:CGFloat)->Flex

Set the start padding.

Depends on the itemLayoutDirection:

• In LTR direction, start padding specify theoffset children should have from the container’s left edge.
• IN RTL direction, start padding specify theoffset children should have from the container’s right edge.

Declaration

publicfuncpaddingStart(_value:CGFloat)->Flex

Set the end padding.

Depends on the itemLayoutDirection:

• In LTR direction, end padding specify theoffset children should have from the container’s right edge.
• IN RTL direction, end padding specify theoffset children should have from the container’s left edge.

Declaration

publicfuncpaddingEnd(_value:CGFloat)->Flex

Set the left, right, start and end paddings to the specified value.

Declaration

publicfuncpaddingHorizontal(_value:CGFloat)->Flex

Set the top and bottom paddings to the specified value.

Declaration

publicfuncpaddingVertical(_value:CGFloat)->Flex

Set paddings using UIEdgeInsets.This method is particularly useful to set all paddings using iOS 11UIView.safeAreaInsets.

Declaration

publicfuncpadding(_insets:UIEdgeInsets)->Flex

Set all paddings to the specified value.

Declaration

publicfuncpadding(_value:CGFloat)->Flex

Set the individually top, left, bottom and right paddings.

Declaration

publicfuncpadding(_top:CGFloat,_left:CGFloat,_bottom:CGFloat,_right:CGFloat)->Flex

Set the view background color.

Declaration

publicfuncbackgroundColor(_color:UIColor)->Flex

Parameters

Return Value

flex interface

Declaration

publicenumDirection

Declaration

publicenumJustifyContent

Declaration

publicenumAlignContent

Declaration

publicenumAlignItems

Declaration

publicenumAlignSelf

Declaration

publicenumWrap

Declaration

publicenumPosition

Declaration

publicenumLayoutDirection

Defines how thelayout(mode:) method layout its flex items.

Declaration

publicenumLayoutMode