ShadowProperty

Table of contents

Description of the View's shadow

Create from source

func NewInsetShadow[xOffsetType SizeUnit | int | float64, yOffsetType SizeUnit | int | float64, blurType SizeUnit | int | float64, spreadType SizeUnit | int | float64](xOffset xOffsetType, yOffset yOffsetType, blurRadius blurType, spreadRadius spreadType, color Color) ShadowProperty

Create the new inset shadow property for a view. xOffset, yOffset are x and y offsets of the shadow (if the argument is specified as int or float64, the value is considered to be in pixels). blurRadius is the blur radius of the shadow (if the argument is specified as int or float64, the value is considered to be in pixels). spreadRadius is the spread radius of the shadow (if the argument is specified as int or float64, the value is considered to be in pixels). color is the color of the shadow.

func NewShadowProperty(params Params) ShadowProperty

Create the new shadow property for a view. The following properties can be used: "color" (ColorTag) - determines the color of the shadow (Color), "x-offset" (XOffset) - determines the shadow horizontal offset (SizeUnit), "y-offset" (YOffset) - determines the shadow vertical offset (SizeUnit), "blur" (BlurRadius) - determines the radius of the blur effect (SizeUnit), "spread-radius" (SpreadRadius) - positive values (SizeUnit) will cause the shadow to expand and grow bigger, negative values will cause the shadow to shrink, "inset" (Inset) - controls (bool) whether to draw shadow inside the frame or outside.

func NewTextShadow[xOffsetType SizeUnit | int | float64, yOffsetType SizeUnit | int | float64, blurType SizeUnit | int | float64](xOffset xOffsetType, yOffset yOffsetType, blurRadius blurType, color Color) ShadowProperty

Create the new text shadow property. Arguments: xOffset, yOffset are the x and y offsets of the shadow (if the argument is specified as int or float64, the value is considered to be in pixels), blurRadius is the blur radius of the shadow (if the argument is specified as int or float64, the value is considered to be in pixels), color is the color of the shadow.

func NewShadow[xOffsetType SizeUnit | int | float64, yOffsetType SizeUnit | int | float64, blurType SizeUnit | int | float64, spreadType SizeUnit | int | float64](xOffset xOffsetType, yOffset yOffsetType, blurRadius blurType, spreadRadius spreadType, color Color) ShadowProperty

Create the new shadow property for a view. xOffset, yOffset are x and y offset of the shadow (if the argument is specified as int or float64, the value is considered to be in pixels). blurRadius is the blur radius of the shadow (if the argument is specified as int or float64, the value is considered to be in pixels). spreadRadius is the spread radius of the shadow (if the argument is specified as int or float64, the value is considered to be in pixels). color is the color of the shadow.

Create from resource

View {
    shadow = _{
        blur = 2px,
        color = #FF5C0700,
        inset = false,
        spread-radius = 0px,
        x-offset = 3px,
        y-offset = 5px,
    },
}

Interface description

Inherit methods from Properties, fmt.Stringer

Properties

"blur"

Determines the radius of the blur effect. The larger this value, the bigger the blur, so the shadow becomes bigger and lighter. Negative values are not allowed

Constant: BlurRadius

Types: SizeUnit, SizeFunc, string, float, int

Internal type is SizeUnit, other types converted to it during assignment

See SizeUnit description for more details

Examples

GridLayout {
    width = 100%,
    height = 100%,
    cell-vertical-align = center,
    cell-horizontal-align = center,
    content = Button {
        content = "Decline",
        shadow = _{
            blur = 1em,
            color = black,
            spread-radius = 0.5em,
        },
    },
}

view := rui.NewGridLayout(session, rui.Params{
    rui.Width:               rui.Percent(100),
    rui.Height:              rui.Percent(100),
    rui.CellVerticalAlign:   rui.CenterAlign,
    rui.CellHorizontalAlign: rui.CenterAlign,
    rui.Content: rui.NewButton(session, rui.Params{
        rui.Content: "Decline",
        rui.Shadow:  rui.NewShadow(rui.Px(0), rui.Px(0), rui.Em(1), rui.Em(0.5), rui.Black),
    }),
})

"color"

Color property of the shadow

Constant: ColorTag

Types: Color, string

Internal type is Color, other types converted to it during assignment

See Color description for more details

Examples

GridLayout {
    width = 100%,
    height = 100%,
    cell-vertical-align = center,
    cell-horizontal-align = center,
    content = Button {
        content = "Decline",
        shadow = _{
            blur = 1em,
            color = black,
            spread-radius = 0.5em,
        },
    },
}

view := rui.NewGridLayout(session, rui.Params{
    rui.Width:               rui.Percent(100),
    rui.Height:              rui.Percent(100),
    rui.CellVerticalAlign:   rui.CenterAlign,
    rui.CellHorizontalAlign: rui.CenterAlign,
    rui.Content: rui.NewButton(session, rui.Params{
        rui.Content: "Decline",
        rui.Shadow:  rui.NewShadow(rui.Px(0), rui.Px(0), rui.Em(1), rui.Em(0.5), rui.Black),
    }),
})

"inset"

Controls whether to draw shadow inside the frame or outside. Inset shadows are drawn inside the border(even transparent ones), above the background, but below content

Constant: Inset

Types: bool, int, string

Values

bool int string Description
true 1 "true", "yes", "on", "1" Drop shadow inside the frame(as if the content was depressed inside the box)
false 0 "false", "no", "off", "0" Shadow is assumed to be a drop shadow(as if the box were raised above the content)

Examples

GridLayout {
    width = 100%,
    height = 100%,
    cell-vertical-align = center,
    cell-horizontal-align = center,
    content = Button {
        content = "Decline",
        shadow = [
            _{
                blur = 0.3em,
                color = black,
                spread-radius = 0.1em,
            },
            _{
                inset = true,
                blur = 0.3em,
                color = black,
                spread-radius = 0.1em,
            },
        ]
    },
}

view := rui.NewGridLayout(session, rui.Params{
    rui.Width:               rui.Percent(100),
    rui.Height:              rui.Percent(100),
    rui.CellVerticalAlign:   rui.CenterAlign,
    rui.CellHorizontalAlign: rui.CenterAlign,
    rui.Content: rui.NewButton(session, rui.Params{
        rui.Content: "Decline",
        rui.Shadow: []rui.ShadowProperty{
            rui.NewShadow(rui.Px(0), rui.Px(0), rui.Em(0.3), rui.Em(0.1), rui.Black),
            rui.NewInsetShadow(rui.Px(0), rui.Px(0), rui.Em(0.3), rui.Em(0.1), rui.Black),
        },
    }),
})

"spread-radius"

Positive values will cause the shadow to expand and grow bigger, negative values will cause the shadow to shrink

Constant: SpreadRadius

Types: SizeUnit, SizeFunc, string, float, int

Internal type is SizeUnit, other types converted to it during assignment

See SizeUnit description for more details

Examples

GridLayout {
    width = 100%,
    height = 100%,
    cell-vertical-align = center,
    cell-horizontal-align = center,
    content = Button {
        content = "Decline",
        shadow = _{
            blur = 1em,
            color = black,
            spread-radius = 0.5em,
        },
    },
}

view := rui.NewGridLayout(session, rui.Params{
    rui.Width:               rui.Percent(100),
    rui.Height:              rui.Percent(100),
    rui.CellVerticalAlign:   rui.CenterAlign,
    rui.CellHorizontalAlign: rui.CenterAlign,
    rui.Content: rui.NewButton(session, rui.Params{
        rui.Content: "Decline",
        rui.Shadow:  rui.NewShadow(rui.Px(0), rui.Px(0), rui.Em(1), rui.Em(0.5), rui.Black),
    }),
})

"x-offset"

Determines the shadow horizontal offset. Negative values place the shadow to the left of the element

Constant: XOffset

Types: SizeUnit, SizeFunc, string, float, int

Internal type is SizeUnit, other types converted to it during assignment

See SizeUnit description for more details

Examples

GridLayout {
    width = 100%,
    height = 100%,
    cell-vertical-align = center,
    cell-horizontal-align = center,
    background-color = lightsalmon,
    content = Button {
        content = "Decline",
        shadow = _{
            x-offset = 0.5em,
            y-offset = 1em,
            blur = 0.2em,
            color = salmon,
            spread-radius = 0.1em,
        },
    },
}

view := rui.NewGridLayout(session, rui.Params{
    rui.Width:               rui.Percent(100),
    rui.Height:              rui.Percent(100),
    rui.CellVerticalAlign:   rui.CenterAlign,
    rui.CellHorizontalAlign: rui.CenterAlign,
    rui.BackgroundColor:     rui.LightSalmon,
    rui.Content: rui.NewButton(session, rui.Params{
        rui.Content: "Decline",
        rui.Shadow: []rui.ShadowProperty{
            rui.NewShadow(rui.Em(0.5), rui.Em(1), rui.Em(0.2), rui.Em(0.1), rui.Salmon),
        },
    }),
})

"y-offset"

Determines the shadow vertical offset. Negative values place the shadow above the element

Constant: YOffset

Types: SizeUnit, SizeFunc, string, float, int

Internal type is SizeUnit, other types converted to it during assignment

See SizeUnit description for more details

Examples

GridLayout {
    width = 100%,
    height = 100%,
    cell-vertical-align = center,
    cell-horizontal-align = center,
    background-color = lightsalmon,
    content = Button {
        content = "Decline",
        shadow = _{
            x-offset = 0.5em,
            y-offset = 1em,
            blur = 0.2em,
            color = salmon,
            spread-radius = 0.1em,
        },
    },
}

view := rui.NewGridLayout(session, rui.Params{
    rui.Width:               rui.Percent(100),
    rui.Height:              rui.Percent(100),
    rui.CellVerticalAlign:   rui.CenterAlign,
    rui.CellHorizontalAlign: rui.CenterAlign,
    rui.BackgroundColor:     rui.LightSalmon,
    rui.Content: rui.NewButton(session, rui.Params{
        rui.Content: "Decline",
        rui.Shadow: []rui.ShadowProperty{
            rui.NewShadow(rui.Em(0.5), rui.Em(1), rui.Em(0.2), rui.Em(0.1), rui.Salmon),
        },
    }),
})

© Alxanosoft inc.