@bodiless/layouts
Advanced tools
Changelog
1.0.0-rc.23 (2023-02-08)
Note: Version bump only for package bodiless-js
Readme
@bodiless/layouts
Ƭ Categories: Object
▪ [key: string]: string[]
bodiless-layouts/src/ComponentSelector/types.tsx:43
Ƭ ComponentSelectorFormProps: Omit<ComponentSelectorProps, "closeForm" | "components" | "mode"> & { components: DesignableComponents }
bodiless-layouts/src/ComponentSelector/componentSelectorForm.tsx:21
Ƭ ComponentSelectorOptions: Pick<ComponentSelectorProps, "mandatoryCategories" | "blacklistCategories">
bodiless-layouts/src/ComponentSelector/types.tsx:174
Ƭ ComponentSelectorProps: ItemListProps & { mandatoryCategories?: string[] ; mode?: ComponentDisplayMode ; ui?: ComponentSelectorUI ; closeForm?: (e?: any) => void }
bodiless-layouts/src/ComponentSelector/types.tsx:24
Ƭ ComponentSelectorUI: Partial<FinalUI>
bodiless-layouts/src/ComponentSelector/types.tsx:172
Ƭ ComponentWithMeta<P>: ComponentType<P> & Meta
| Name | Type |
|---|---|
P | any |
bodiless-layouts/src/ComponentSelector/types.tsx:70
Ƭ ComponentWithPartialMeta<P>: ComponentType<P> & Partial<Meta>
| Name | Type |
|---|---|
P | any |
bodiless-layouts/src/ComponentSelector/types.tsx:71
Ƭ CreateFlowContainerItem: (args: CreateFlowContainerItemArgs) => FlowContainerItem
▸ (args): FlowContainerItem
| Name | Type |
|---|---|
args | CreateFlowContainerItemArgs |
bodiless-layouts/src/deserializers/createFlowContainerItem.ts:28
Ƭ CreateFlowContainerItemArgs: Object
| Name | Type |
|---|---|
element | Element | Element[] |
elementIndex | number |
type | string |
bodiless-layouts/src/deserializers/createFlowContainerItem.ts:23
Ƭ DeserializeElement: (args: DeserializeElementArgs) => FlowContainerData
▸ (args): FlowContainerData
| Name | Type |
|---|---|
args | DeserializeElementArgs |
FlowContainerData
bodiless-layouts/src/deserializers/htmlDeserializer.ts:35
Ƭ Deserializer: Object
| Name | Type |
|---|---|
merge | boolean |
type | string |
deserialize | (item: FlowContainerItem, elements: Element[]) => FlowContainerItemData |
map | (elements: Element[], elementIndex: number) => FlowContainerItem |
match | (element: Element) => boolean |
bodiless-layouts/src/deserializers/deserializer.ts:21
Ƭ FinalUI: Object
| Name | Type |
|---|---|
AccordionCheckBox | ComponentType<HTMLProps<HTMLInputElement>> | string |
AccordionCheckboxLabel | ComponentType<HTMLProps<HTMLLabelElement>> | string |
AccordionCheckboxLabelText | ComponentType<HTMLProps<HTMLSpanElement>> | string |
AccordionCheckboxWrapper | ComponentType<HTMLProps<HTMLDivElement>> | string |
AccordionIconContract | ComponentType<HTMLProps<HTMLSpanElement>> | string |
AccordionIconExpand | ComponentType<HTMLProps<HTMLSpanElement>> | string |
AccordionItemWrapper | ComponentType<HTMLProps<HTMLAnchorElement>> | string |
AccordionLabel | ComponentType<HTMLProps<HTMLLabelElement>> | string |
AccordionWrapper | ComponentType<HTMLProps<HTMLDivElement>> | string |
CloseMenuIcon | ComponentType<HTMLProps<HTMLSpanElement>> | string |
ComponentDescriptionIcon | ComponentType<HTMLProps<HTMLDivElement>> | string |
ComponentDescriptionStyle | ComponentType<HTMLProps<HTMLDivElement>> | string |
ComponentDescriptionWrapper | ComponentType<HTMLProps<HTMLDivElement>> | string |
ComponentLinkWrapper | ComponentType<HTMLProps<HTMLAnchorElement>> | string |
ComponentPreviewStyle | ComponentType<HTMLProps<HTMLImageElement>> | string |
ComponentSelectButton | ComponentType<HTMLProps<HTMLButtonElement>> | string |
ComponentSelectorWrapper | ComponentType<HTMLProps<HTMLDivElement>> | string |
ComponentTitleWrapper | ComponentType<HTMLProps<HTMLHeadingElement>> | string |
FlexSection | ComponentType<HTMLProps<HTMLDivElement>> | string |
FlexSectionFull | ComponentType<HTMLProps<HTMLDivElement>> | string |
FlowContainerEmpty | ComponentType<HTMLProps<HTMLDivElement>> | string |
GridListBox | ComponentType<HTMLProps<HTMLDivElement>> | string |
GridListBoxInner | ComponentType<HTMLProps<HTMLDivElement>> | string |
GridListBoxWrapper | ComponentType<HTMLProps<HTMLDivElement>> | string |
IconWrapper | ComponentType<HTMLProps<HTMLSpanElement>> | string |
ItemBox | ComponentType<HTMLProps<HTMLDivElement>> | string |
ItemBoxWrapper | ComponentType<HTMLProps<HTMLDivElement>> | string |
MasterWrapper | ComponentType<HTMLProps<HTMLDivElement>> | string |
ScalingButtonFull | ComponentType<HTMLProps<HTMLElement>> | string |
ScalingButtonHalf | ComponentType<HTMLProps<HTMLElement>> | string |
ScalingButtonQuarter | ComponentType<HTMLProps<HTMLElement>> | string |
ScalingHeader | ComponentType<HTMLProps<HTMLDivElement>> | string |
SearchBar | ComponentType<HTMLProps<HTMLInputElement>> | string |
SearchBarWrapper | ComponentType<HTMLProps<HTMLDivElement>> | string |
SubmitButton | ComponentType<HTMLProps<HTMLButtonElement>> | string |
TitleWrapper | ComponentType<HTMLProps<HTMLSpanElement>> | string |
bodiless-layouts/src/ComponentSelector/types.tsx:95
Ƭ FlowContainerItem: Object
| Name | Type |
|---|---|
type | string |
uuid | string |
wrapperProps | { [key: string]: string; } |
bodiless-layouts/src/deserializers/createFlowContainerItem.ts:17
Ƭ FlowContainerItemData: Object
▪ [itemNodeKey: string]: any
bodiless-layouts/src/deserializers/deserializer.ts:17
Ƭ FlowContainerProps: Omit<FlowContainerBaseProps, "components"> & DesignableProps
bodiless-layouts/src/FlowContainer/types.ts:56
Ƭ FlowContainerWrapperProps: Object
| Name | Type |
|---|---|
itemCount | number |
bodiless-layouts/src/FlowContainer/types.ts:86
Ƭ ItemListProps: Object
Props passed to the list of items within the component selector.
| Name | Type | Description |
|---|---|---|
blacklistCategories? | string[] | List of categories which should never be shown in the filters. |
components | ComponentWithMeta[] | An array of components with metadata (at leassts displayName, title, description) |
scale? | ComponentSelectorScale | Initial scale |
onSelect | (names: string[]) => void | Callback when one or more components are selected. |
bodiless-layouts/src/ComponentSelector/types.tsx:76
Ƭ LibraryItemContextProps: Object
Flow Container Library Item Context Props where isLibraryItem defaults to true
if FlowContainerItem is actually a Library Item.
| Name | Type |
|---|---|
isLibraryItem | boolean |
setIsLibraryItem | React.Dispatch<React.SetStateAction<boolean>> |
bodiless-layouts/src/ContentLibrary/withLibraryContext.tsx:47
Ƭ LibraryItemProviderProps: Object
Flow Container Library Item Provider Props.
| Name | Type |
|---|---|
isLibrary | boolean |
bodiless-layouts/src/ContentLibrary/withLibraryContext.tsx:39
Ƭ Meta: Object
Component metadata used to search, filter and display information about a component,
| Name | Type | Description |
|---|---|---|
categories? | Categories | Category and value pairs for facets |
description | string | Description to display in the item selector |
displayName | string | default static prop for react component to distingush it in the render tree |
title | string | Title to show in the item selector menu |
bodiless-layouts/src/ComponentSelector/types.tsx:51
Ƭ SelectorComponentsInterface: Object
Interface for an object which exposes two sets of components: those needed to render the flow container or chameleon, and those needed to render the component selector.
| Name | Type | Description |
|---|---|---|
components | DesignableComponents | The components needed to render the flow container itself |
selectableComponents | DesignableComponents | The components neededd to render the component selector. |
bodiless-layouts/src/ComponentSelector/SelectorComponents.tsx:26
Ƭ SelectorComponentsProps: Object
Properties which must be passed to the constructor of the SelectorComponents class.
| Name | Type |
|---|---|
DefaultComponent | ComponentOrTag<any> |
design | Design |
selectedComponents | string[] |
startComponents? | DesignableComponents |
bodiless-layouts/src/ComponentSelector/SelectorComponents.tsx:41
Ƭ SortableResizableProps: Object
| Name | Type |
|---|---|
children | React.ReactNode |
className | string |
defaultSize? | { height?: string | number ; width?: string | number } |
defaultSize.height? | string | number |
defaultSize.width? | string | number |
direction? | string |
isEnabled | boolean |
onClick? | React.MouseEventHandler |
onResize? | ResizeCallback |
onResizeStop? | ResizeCallback |
snapData? | SnapData |
ui? | SortableResizableUI |
bodiless-layouts/src/SortableResizableWrapper/index.tsx:39
Ƭ SortableResizableUI: Partial<FinalUI>
bodiless-layouts/src/SortableResizableWrapper/index.tsx:28
Ƭ WithTitleFromTermsProps: Object
Type of the options for withTitleFromTerms
| Name | Type | Description |
|---|---|---|
blacklistCategories? | string[] | List of categories which should be excluded when creating the title. |
blacklistTerms? | string[] | List of terms which should be exclued when building the title. |
separator? | string | Term separator |
createTitleSegment? | (category: string, term: string) => string | Function which takes a category and term and returns the string which should be used for that segment of the title. |
bodiless-layouts/src/meta/withTitleFromTerms.tsx:23
• Const CONTENT_LIBRARY_TYPE_PREFIX: "ContentLibrary"
Default Prefix for the Library Item Flow Container Item type.
bodiless-layouts/src/ContentLibrary/withLibraryContext.tsx:25
• Const ComponentSelector: React.FC<ComponentSelectorProps>
bodiless-layouts/src/ComponentSelector/index.tsx:85
• Const DIRECTIONS: Object
| Name | Type |
|---|---|
LTR | LanguageDirection |
RTL | LanguageDirection |
bodiless-layouts/src/withDirection/withDirection.tsx:22
• Const FlowContainer: ComponentType<FlowContainerProps>
bodiless-layouts/src/FlowContainer/index.tsx:49
• Const LibraryItemContext: Context<LibraryItemContextProps>
Flow Container Library Item Context.
see LibraryItemContextProps
bodiless-layouts/src/ContentLibrary/withLibraryContext.tsx:56
• Const LibraryItemProvider: FC<LibraryItemProviderProps>
A LibraryItemProvider indicates whether the current Flow Container Item is a Library Item.
see LibraryItemProviderProps.
bodiless-layouts/src/ContentLibrary/withLibraryContext.tsx:79
• Const SlateSortableResizable: Object
▸ (props): Element
| Name | Type |
|---|---|
props | SlateSortableResizableProps |
Element
| Name | Type |
|---|---|
defaultProps | { defaultSize: { height: string = ''; width: string = '' } ; onResize: () => void } |
defaultProps.defaultSize | { height: string = ''; width: string = '' } |
defaultProps.defaultSize.height | string |
defaultProps.defaultSize.width | string |
defaultProps.onResize | () => void |
displayName | string |
bodiless-layouts/src/SlateSortableResizable.tsx:120
• Const SortableResizableWrapper: ComponentClass<SortableResizableProps & SortableElementProps, any>
bodiless-layouts/src/SortableResizableWrapper/index.tsx:59
▸ SortableChild(props): Element
This is the component which wraps all items in the flow container. You probably only need to use it directly if you are customizing the Admin UI.
| Name | Type |
|---|---|
props | SortableChildProps |
Element
bodiless-layouts/src/FlowContainer/SortableChild.tsx:30
▸ asPassThough(Component): CTWM
| Name | Type |
|---|---|
Component | CTWM |
CTWM
bodiless-layouts/src/meta/index.tsx:30
▸ componentSelectorForm(props): (props: Omit<ContextMenuFormProps, "children">) => Element
Returns a component selector wrapped in a context menu form.
| Name | Type | Description |
|---|---|---|
props | ComponentSelectorFormProps | Props passed to the edit flow container. |
fn
▸ (props): Element
| Name | Type |
|---|---|
props | Omit<ContextMenuFormProps, "children"> |
Element
bodiless-layouts/src/ComponentSelector/componentSelectorForm.tsx:32
▸ createDefaultDeserializer(type): Deserializer
| Name | Type |
|---|---|
type | string |
bodiless-layouts/src/deserializers/defaultDeserializers.ts:21
▸ createFlowContainerItem(args): FlowContainerItem
| Name | Type |
|---|---|
args | CreateFlowContainerItemArgs |
bodiless-layouts/src/deserializers/createFlowContainerItem.ts:37
▸ createListDeserializer(type, linkKey, titleKey): Deserializer
| Name | Type |
|---|---|
type | string |
linkKey | string |
titleKey | string |
bodiless-layouts/src/deserializers/listDeserializer.ts:64
▸ deserializeHtml(html, deserializers, domParser?): FlowContainerData
| Name | Type |
|---|---|
html | string |
deserializers | Deserializer[] |
domParser? | DOMParser |
FlowContainerData
bodiless-layouts/src/deserializers/htmlDeserializer.ts:71
▸ deserializeList(linkKey, titleKey): (item: FlowContainerItem, elements: Element[]) => ListData
| Name | Type |
|---|---|
linkKey | string |
titleKey | string |
fn
▸ (item, elements): ListData
| Name | Type |
|---|---|
item | FlowContainerItem |
elements | Element[] |
ListData
bodiless-layouts/src/deserializers/listDeserializer.ts:23
▸ generateUuid(content, index): string
| Name | Type |
|---|---|
content | string |
index | number |
string
bodiless-layouts/src/deserializers/createFlowContainerItem.ts:30
▸ getSnapFrom(...withTuples): SnapData
| Name | Type |
|---|---|
...withTuples | WithTuples[] |
SnapData
bodiless-layouts/src/FlowContainer/utils/appendTailwindWidthClass.ts:140
▸ ifComponentSelector<B1, A1, R1, A2, R2, A3, R3, A4, R4, A5, R5, A6, R6, A7, R7, A8, R8, A9, R9>(t1?, t2?, t3?, t4?, t5?, t6?, t7?, t8?, t9?, ...t): HOCWithMeta<B1, object & A1 & A2 & A3 & A4 & A5 & A6 & A7 & A8 & A9, R1 & R2 & R3 & R4 & R5 & R6 & R7 & R8 & R9>
| Name |
|---|
B1 |
A1 |
R1 |
A2 |
R2 |
A3 |
R3 |
A4 |
R4 |
A5 |
R5 |
A6 |
R6 |
A7 |
R7 |
A8 |
R8 |
A9 |
R9 |
| Name | Type |
|---|---|
t1? | HOCDef<B1, A1, R1> |
t2? | HOCDef<{}, A2, R2> |
t3? | HOCDef<{}, A3, R3> |
t4? | HOCDef<{}, A4, R4> |
t5? | HOCDef<{}, A5, R5> |
t6? | HOCDef<{}, A6, R6> |
t7? | HOCDef<{}, A7, R7> |
t8? | HOCDef<{}, A8, R8> |
t9? | HOCDef<{}, A9, R9> |
...t | HOCDef<any, any, any>[] |
HOCWithMeta<B1, object & A1 & A2 & A3 & A4 & A5 & A6 & A7 & A8 & A9, R1 & R2 & R3 & R4 & R5 & R6 & R7 & R8 & R9>
bodiless-layouts/src/FlowContainer/ComponentDisplayMode.tsx:50
▸ ifNotComponentSelector<B1, A1, R1, A2, R2, A3, R3, A4, R4, A5, R5, A6, R6, A7, R7, A8, R8, A9, R9>(t1?, t2?, t3?, t4?, t5?, t6?, t7?, t8?, t9?, ...t): HOCWithMeta<B1, object & A1 & A2 & A3 & A4 & A5 & A6 & A7 & A8 & A9, R1 & R2 & R3 & R4 & R5 & R6 & R7 & R8 & R9>
| Name |
|---|
B1 |
A1 |
R1 |
A2 |
R2 |
A3 |
R3 |
A4 |
R4 |
A5 |
R5 |
A6 |
R6 |
A7 |
R7 |
A8 |
R8 |
A9 |
R9 |
| Name | Type |
|---|---|
t1? | HOCDef<B1, A1, R1> |
t2? | HOCDef<{}, A2, R2> |
t3? | HOCDef<{}, A3, R3> |
t4? | HOCDef<{}, A4, R4> |
t5? | HOCDef<{}, A5, R5> |
t6? | HOCDef<{}, A6, R6> |
t7? | HOCDef<{}, A7, R7> |
t8? | HOCDef<{}, A8, R8> |
t9? | HOCDef<{}, A9, R9> |
...t | HOCDef<any, any, any>[] |
HOCWithMeta<B1, object & A1 & A2 & A3 & A4 & A5 & A6 & A7 & A8 & A9, R1 & R2 & R3 & R4 & R5 & R6 & R7 & R8 & R9>
bodiless-layouts/src/FlowContainer/ComponentDisplayMode.tsx:51
▸ isLibraryItem(item): boolean
Check if the current Flow Container Item is Library Item
| Name | Type | Description |
|---|---|---|
item | FlowContainerItem | FlowContainerItem |
boolean
boolean
bodiless-layouts/src/ContentLibrary/withLibraryContext.tsx:33
▸ perserveMeta(hoc): HOC<{}, {}, {}>
preserveMeta returns takes an hoc and returns another one that will apply the hoc but preserve theMeta data from the component.
| Name | Type | Description |
|---|---|---|
hoc | HOC<{}, {}, {}> | the hoc to wrap. |
HOC<{}, {}, {}>
bodiless-layouts/src/meta/index.tsx:111
▸ useIsLibraryItem(): boolean
Hook to check if the current Flow Container Item is Library Item
Must only be used on FlowContainerItem.
boolean
boolean
bodiless-layouts/src/ContentLibrary/withLibraryContext.tsx:73
▸ useLibraryItemContext(): LibraryItemContextProps
Hook that can be used to access the Flow Container Library Item Context.
Component must be within a LibraryItemProvider.
see LibraryItemContextProps
bodiless-layouts/src/ContentLibrary/withLibraryContext.tsx:66
▸ useSelectorComponents(props): SelectorComponents
| Name | Type |
|---|---|
props | Partial<SelectorComponentsProps> |
bodiless-layouts/src/ComponentSelector/SelectorComponents.tsx:125
▸ withAllTitlesFromTerms(ops?): HOC<{}, {}, {}>
Creates a token which can be applied to a flow container so that all its components will have a default title generated based on their metadata.
| Name | Type | Description |
|---|---|---|
ops | WithTitleFromTermsProps | Options defining how the title should be created. |
HOC<{}, {}, {}>
HOC which adds a default title to all components in the flow container.
bodiless-layouts/src/meta/withTitleFromTerms.tsx:98
▸ withAppendDesc(newDescription): HOC<{}, {}, {}>
withAppendDesc returns an HOC that appends a description to the component sideload description.
| Name | Type | Description |
|---|---|---|
newDescription | string | the description to be appended |
HOC<{}, {}, {}>
bodiless-layouts/src/meta/index.tsx:92
▸ withAppendDisplayName(newDisplayName): HOC<{}, {}, {}>
withAppendDisplayName returns a HOC that appends a name to the sideloaded DisplayName
| Name | Type | Description |
|---|---|---|
newDisplayName | string | the Display name to append |
HOC<{}, {}, {}>
bodiless-layouts/src/meta/index.tsx:74
▸ withAppendTitle(newTitle): HOC<{}, {}, {}>
withAppendTitle returns an HOC that appends to the sideload title of the component Note it appends to the title with a space.
| Name | Type |
|---|---|
newTitle | string |
HOC<{}, {}, {}>
bodiless-layouts/src/meta/index.tsx:56
▸ withContentLibrary(options): <P>(Component: ComponentOrTag<P>) => any
| Name | Type |
|---|---|
options | ContentLibraryOptions |
fn
▸ <P>(Component): any
| Name | Type |
|---|---|
P | extends object |
| Name | Type |
|---|---|
Component | ComponentOrTag<P> |
any
bodiless-layouts/src/ContentLibrary/withContentLibrary.tsx:36
▸ withDesc(description): HOC<{}, {}, {}>
withDesc returns an HOC that sideloads the provided description to the component.
| Name | Type | Description |
|---|---|---|
description | string | the description to add |
HOC<{}, {}, {}>
bodiless-layouts/src/meta/index.tsx:85
▸ withDirection(langDirection): Injector<{ direction: Direction = langDirection }, object>
| Name | Type |
|---|---|
langDirection | Direction |
Injector<{ direction: Direction = langDirection }, object>
bodiless-layouts/src/withDirection/withDirection.tsx:27
▸ withDisplayName(displayName): HOC<{}, {}, {}>
withDisplayName returns an HOC that sideloads a displayName to a component
| Name | Type | Description |
|---|---|---|
displayName | string | The displayName to be added |
HOC<{}, {}, {}>
bodiless-layouts/src/meta/index.tsx:67
▸ withFacet(cat): (term: string) => (...hocs: HOC<{}, {}, {}>[]) => HOCWithMeta<{}, {}, {}>
withFacet is expect to be passed to an on function and takes a term and and hoc (using curring) and returns a Variant that can be used in the on function
| Name | Type | Description |
|---|---|---|
cat | string | Category that the Component will be apart |
fn
▸ (term): (...hocs: HOC<{}, {}, {}>[]) => HOCWithMeta<{}, {}, {}>
| Name | Type |
|---|---|
term | string |
fn
▸ (...hocs): HOCWithMeta<{}, {}, {}>
| Name | Type |
|---|---|
...hocs | HOC<{}, {}, {}>[] |
HOCWithMeta<{}, {}, {}>
bodiless-layouts/src/meta/index.tsx:122
▸ withFlowContainerDefaultHtml(deserializers, html?): Enhancer<{ html?: string }, {}>
| Name | Type |
|---|---|
deserializers | Deserializer[] |
html? | string |
Enhancer<{ html?: string }, {}>
bodiless-layouts/src/deserializers/withFlowContainerDefaultHtml.tsx:24
▸ withLibraryComponents(path?, collection?): HOCWithMeta<{}, {}, {}>
Adds content library support to Bodiless flow container component to allow saving item component with all its content.
withLibraryComponents provides flow container menu options for adding library name and description. Also adding library design to flow container so it displays item component with saved library type.
| Name | Type | Default value | Description |
|---|---|---|---|
path | LibraryNodePath | DEFAULT_CONTENT_LIBRARY_PATH | user specified library node path for data storage. |
collection | string | DEFAULT_CONTENT_LIBRARY_COLLECTION | - |
HOCWithMeta<{}, {}, {}>
Token
bodiless-layouts/src/ContentLibrary/withLibraryComponents.tsx:322
▸ withLibraryItemContext<P>(C): ComponentWithMeta<PP<P, {}, {}>>
HOC that wraps component in LibraryItemProvider.
When wrapped in LibraryItemProvider, it checks whether FlowContainerItem
is actually a Library Item by checking its FlowContainerItem.type prefix.
see LibraryItemContextProps
| Name | Type |
|---|---|
P | extends any |
| Name | Type |
|---|---|
C | ComponentOrTag<P> |
ComponentWithMeta<PP<P, {}, {}>>
bodiless-layouts/src/ContentLibrary/withLibraryContext.tsx:95
▸ withMandatoryCategories(categories): Injector<{ mandatoryCategories: string[] = categories }, object>
| Name | Type |
|---|---|
categories | string[] |
Injector<{ mandatoryCategories: string[] = categories }, object>
bodiless-layouts/src/FlowContainer/index.tsx:45
▸ withMeta(meta): HOC<{}, {}, {}>
withMeta creates an HOC that will add meta data to a React Component
| Name | Type | Description |
|---|---|---|
meta | Object | the data to be side loaded in to the component |
HOC<{}, {}, {}>
bodiless-layouts/src/meta/index.tsx:40
▸ withTailwindClasses(tailwindConfig): (classes: string) => WithTuples
withTailwindClasses returns a withTuple function that take the tailwind class and creates tuples for each one of them.
| Name | Type | Description |
|---|---|---|
tailwindConfig | Config | The Tailwind config to use for extraction of size data |
fn
▸ (classes): WithTuples
| Name | Type |
|---|---|
classes | string |
WithTuples
bodiless-layouts/src/FlowContainer/utils/appendTailwindWidthClass.ts:62
▸ withTailwindWidthConstraints(config): (classes: string) => Injector<{ snapData: SnapData }, object>
| Name | Type |
|---|---|
config | any |
fn
▸ (classes): Injector<{ snapData: SnapData }, object>
| Name | Type |
|---|---|
classes | string |
Injector<{ snapData: SnapData }, object>
bodiless-layouts/src/FlowContainer/utils/appendTailwindWidthClass.ts:185
▸ withTerm(cat): (term: string) => HOC<{}, {}, {}>
withTerm returns a function that then takes a term and that returns an HOC that side loads the category and term on to the component.
| Name | Type | Description |
|---|---|---|
cat | string | that category to use in adding a term |
fn
▸ (term): HOC<{}, {}, {}>
| Name | Type |
|---|---|
term | string |
HOC<{}, {}, {}>
bodiless-layouts/src/meta/index.tsx:103
▸ withTitle(title): HOC<{}, {}, {}>
with Title returns an HOC that sideloads a title to a component
| Name | Type | Description |
|---|---|---|
title | string | The title to be added |
HOC<{}, {}, {}>
bodiless-layouts/src/meta/index.tsx:48
▸ withTitleFromTerms(ops?): HOC<{}, {}, {}>
Creates a token which adds a title property to a component. This is derived from all
terms which have been applied to that component.
The new title will only be added if the component does not already have a title.
| Name | Type | Description |
|---|---|---|
ops | WithTitleFromTermsProps | Options for generating the title. |
HOC<{}, {}, {}>
A token which adds a title.
bodiless-layouts/src/meta/withTitleFromTerms.tsx:81
▸ withTuple(media): (width: number) => (className: string) => WithTuples
Curry function that returns a withTuple to be used a snapOptions function.
returns: a Tuple with the given information
see snapOptions
| Name | Type |
|---|---|
media | string |
fn
▸ (width): (className: string) => WithTuples
| Name | Type |
|---|---|
width | number |
fn
▸ (className): WithTuples
| Name | Type |
|---|---|
className | string |
WithTuples
bodiless-layouts/src/FlowContainer/utils/appendTailwindWidthClass.ts:44
FAQs
Layout managers for BodilessJS.
The npm package @bodiless/layouts receives a total of 5 weekly downloads. As such, @bodiless/layouts popularity was classified as not popular.
We found that @bodiless/layouts demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
Application Security
New SEC disclosure rules aim to enforce timely cyber incident reporting, but fear of job loss and inadequate resources lead to significant underreporting.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).
