Models.ContainerStyle Class
Namespace: Nucleus.Abstractions.Models
Assembly: Nucleus.Abstractions.dll
Class used to specify the properties of a container style.
Remarks
Container styles are a representation of set of special Css @property elements and related css classes which provide generic style control for containers.
Constructors
ContainerStyle
ContainerStyle ()
Constructor.
ContainerStyle (String) Constructor
ContainerStyle (String name)
Constructor.
Parameters
| Name | Type |
|---|---|
| name | String |
Properties
BaseCssClass Property
Specifies a "base" css class which must be applied to any container which has a style value from this container style selected.
Examples
@property --border-color
{
/* title: Border Color */
/* baseClass: container-border */
syntax: "<color>";
inherits: true;
initial-value: black;
}
Remarks
This is used for cases where a css class must be added for any of the available style values to work. For example, the container-border css class must be added to a container which has any of the border values selected. To specify a container style base class, add a comment inside the body of the relevant css @parameter class in the form: /* baseClass: your-class */
CustomValue Property
A custom value for the container style. This value can be null.
Disabled Property
Specifies that the container property is disabled. This is used by containers which needs to suppress unsupported container properties, like the no-title container, which disables the title-related container properties.
Group Property
Specifies the group for the container style. Styles are group by 'Group' in the module settings page.
Examples
@property --border-color
{
/* title: Border Color */
/* group: Border */
syntax: "<color>";
inherits: true;
initial-value: black;
}
Remarks
To specify a container style group, add a comment inside the body of the relevant css @parameter class in the form: /* group: your-group */
Name Property
The name of the style value. This is derived from the Css @property name if the property which represents this container style.
PreserveOrder Property
Specifies that the values should appear in the order that they are specified in the css file.
Examples
@property --title-alignment
{
/* title: Title Alignment */
/* preserveOrder: true */
...
}
Remarks
This is used for cases where values should not be sorted alphabetically. To specify the preserveOrder property, add a comment inside the body of the relevant css @parameter class in the form: /* preserveOrder: true */
SelectedValue Property
The Css class of the selected container style value. This value can be null.
Syntax Property
Specifies the syntax of the underlying css property in the form specified by https://drafts.css-houdini.org/css-properties-values-api/#the-syntax-descriptor.
Title Property
The display text for the container style, used for on-screen display.
Examples
@property --border-color
{
/* title: Border Color */
/* baseClass: container-border */
syntax: "<color>";
inherits: true;
initial-value: black;
}
Remarks
To specify a container style title, add a comment inside the body of the relevant css @parameter class in the form: /* title: your-title-value */
Values Property
A list of available values for the container style.