package
1.0.16
Repository: https://github.com/sirclo-solution/sirchat.git
Documentation: pkg.go.dev

# Functions

NewAction use to create new action.
NewButtonBlock returns a new instance of a button block to be rendered.
NewCardBlock returns a new instance of a card block to be rendered.
NewCarouselBlock returns a new instance of a section block to be rendered.
NewCollapsibleBlock returns a new instance of a collapsible block to be rendered.
NewContainerBlock returns a new instance of a container block to be rendered.
NewDialog used for initialization of new dialog components NewDialog returns a new instance of a dialog component to be rendered.
NewDividerBlock returns a new instance of a divider block to be rendered.
NewDrawer used for initialization of new drawer components.
NewIconBlock returns a new instance of a section block to be rendered.
NewImageBlock returns a new instance of a section block to be rendered.
NewInputBlock returns a new instance of a input block to be rendered.
NewMessage used for initialization of new message components NewMessage returns a new instance of a message component to be rendered.
NewNotification used for initialization of new notification components NewNotification returns a new instance of a notification component to be rendered.
NewNotificationBlock returns a new instance of a section block to be rendered.
NewPillBlock returns a new instance of a section block to be rendered.
NewPromptBlock returns a new instance of a prompt block to be rendered.
NewSubheading returns a new instance of a subheading object to be used in drawer component.
NewTableBlock returns a new instance of a table block to be rendered.
NewTextBlock returns a new instance of a section block to be rendered.
NewTextListBlock returns a new instance of a section block to be rendered.
NewTitle use to create new title.

# Constants

Items are positioned at the center of the container.
Items are positioned at the end of the container.
Items are positioned at the beginning of the container.
ButtonBlockObjectColorDanger this is a danger color (#D64241).
ButtonBlockObjectColorPrimary this is a primary color (#269CD9).
ButtonBlockObjectColorSecondary this is a secondary color (#52697A).
ButtonObjectIconCart this is a cart icon.
ButtonObjectIconTrash this is a delete icon (X).
ButtonObjectIconEdit this is an edit icon.
ButtonObjectIconIntegrate this is an integrate icon.
ButtonObjectIconRedirect this is a redirect icon.
ButtonObjectIconReload this is a reload icon.
ButtonObjectIconTrash this is a trash icon.
ButtonObjectIconView this is a view icon.
ButtonObjectSizeLarge this is a large size.
ButtonObjectSizeMedium this is a medium size.
ButtonObjectSizeSmall this is a small size.
ButtonObjectVariantContained this is a contained variant.
ButtonObjectVariantOutlined this is a outlined variant.
ButtonObjectVariantText this is a text variant.
CDColumn this is a column/vertical direction.
CDRow this is a row/horizontal direction.
CPCenter this is a center position.
CPEnd this is a final position according to direction.
CPStart this is a starting position according to direction.
InputBlockObjectTypeCheckbox is the type for checkbox input.
InputBlockObjectTypeCounter is the type for counter input.
InputBlockObjectTypeDistrictSelect is the type for district_select input.
InputBlockObjectTypeEmail is the type for email input.
InputBlockObjectTypeNumber is the type for number input.
InputBlockObjectTypePassword is the type for text area input.
InputBlockObjectTypeRadio is the type for radio input.
InputBlockObjectTypeSelect is the type for select input.
InputBlockObjectTypeText is the type for text input.
InputBlockObjectTypeTextArea is the type for text area input.
Items are positioned in the center of the container.
Items are positioned at the end of the container.
Items will have space between them.
Items are positioned at the beginning of the container.
MBTButton is the type for button block.
MBTCard is the type for card block.
MBTCarousel is the type for carousel block.
MBTCollapsible is the type for collapsible block.
MBTContainer is the type for container block.
MBTDivider is the type for divider block.
MBTIcon is the type for icon block.
MBTImage is the type for image block.
MBTInput is the type for input block.
MBTNotification is the type for notification block.
MBTPill is type for pill block.
MBTTable is the type for table block.
MBTTAction this is a button type.
MBTTCancel this is a cancel type.
MBTText is the type for text block.
MBTTextList is the type for text list block.
MBTTSubmit this is a submit type.
MCTDialog is the type for dialog component.
MCTDrawer is the type for drawer component.
MCTMessage is the type for message component.
MCTNotification is the type for notification component.
MNOTFailed is the type for failed notification.
MNOTSuccess is the type for success notification.
this type contains error information.
this type display information.
this type contains success information.
this type contains waning information.
danger type will use danger (#d64241).
info_1 type will use info (#1478c9); this type will lighter than info_2.
info_2 type will use info (#083f87); this type will darker than info_1.
primary type will use primary (#1c9aea).
secondary_1 type will use secondary (#1c9aea) with grey text (#1c9aea).
secondary_2 type will use secondary (#1c9aea) with white text (#ffffff).
success_1 type will use success (#00b969); this type will ligther than success_2.
success_2 type will use success (#008566); this type will darker than success_1.
warning type will use warning (#ffb300).
center align is center position text.
left align is left position text.
right align is right position text.
danger color is red (#E05D52).
disabled color is silver or text disabled (#D0D9E0).
primary color is primary (#269CD9).
secondary color is secondary (#7590A3).
text color is text (#3D4F5C).
figure type is 16px bold (color: primary (#269CD9)).
heading type is 16px bold.
paragraph type is 14px medium.
span type is 12px medium.
subheading type is 14px bold.
subheading2 type is 12px bold.
title type is 24px bold.

# Structs

Action contains multiple buttons block and action id.
No description provided by the author
ButtonActionObject.
ButtonBlockObject holds the detail of the ButtonBlock.
CardBlockObject holds the detail of the CardBlock.
CarouselBlockObject defines detail of block carousel.
CollapsibleBlockObject holds the detail of the collapsibleBlock.
ContainerBlockObject holds the detail of the ContainerBlock.
No description provided by the author
HeaderObject is the struct for field `Header` in TableBlockObject.
IconBlockObject holds the detail of the IconBlock.
ImageBlockObject holds the detail of the ImageBlock.
InputActionObject is an action that will trigger to the next action with the appropriate payload filled in the input.
InputBlockObject holds the detail of the InputBlock.
InputBlockOptionsObject is the options for radio InputBlockObject type.
MessageImageObject holds the image detail for MessageObject.
MessageObject holds the detail of the MessageObject.
MessageTextObject holds the text body for MessageObject.
NotificationBlockObject holds the detail of the NotificationBlock.
NotificationObject holds the image detail for MessageObject.
PillBlockObject holds the detail of the PillBlock.
PromptBlockObject holds the detail of the PromptBlock.
Subheading is a part of drawer component.
TableBlockObject holds the detail of the TableBlock.
TextBlockObject holds the detail of the TextBlock.
TextHeaderObject is the struct for field `Text` in HeaderObject.
TextBlock is a subtype of block.
Title is title on the component.

# Interfaces

IAppendable an interface which has an AddBlocks method.
IBlock is the interface for blocks.
IComponent is the interface for components.

# Type aliases

AlignItemsPosition used to specifies the default alignment for items inside the flexible container the available positions are start, center, and end.
ButtonBlockObjectColor this is a color of the button.
ButtonBlockObjectIcon this is a icon of the button.
ButtonBlockObjectSize this is a size of the button.
ButtonBlockObjectType this is type of the button.
ButtonBlockObjectVariant this is a variant of the button.
ContainerDirection is a block stack direction.
ContainerPosition is a position of container, the position is start, center, end.
InputBlockObjectType is a type for field `Input` in InputBlockObject.
JustifyContentPosition used to aligns the flexible container's items when the items do not use all available space on the main-axis (horizontally) the available positions are start, center, end, and space-between.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PillBlockObjectType is a type to define type pill.
TextBlockObjectAlign is a type to define align text.
TextBlockObjectColor is a type to define color text.
TextBlockObjectType is a type to define type text.