BoxDecoration

BoxDecoration provides a description of how to paint a box. The box has a border, a body, and may cast a shadow.

Properties

• bgcolor(ColorValue | None) –

  The color to fill in the background of

• blend_mode(BlendMode | None) –

  The blend mode to apply to the background bgcolor or gradient.

• border(Border | None) –

  A border to draw above the background bgcolor, gradient,

• border_radius(BorderRadiusValue | None) –

  The border radius of the box.

• gradient(Gradient | None) –

  A gradient to use when filling the box.

• image(DecorationImage | None) –

  An image to paint above the background bgcolor or gradient.

• shadows(BoxShadowValue | None) –

  A list of shadows cast by the box.

• shape(BoxShape) –

  The shape to fill the bgcolor, gradient, and image

Methods

• copy –

Properties

bgcolor class-attribute instance-attribute

bgcolor: ColorValue | None = None

The color to fill in the background of the box.

blend_mode class-attribute instance-attribute

blend_mode: BlendMode | None = None

The blend mode to apply to the background bgcolor or gradient.

border class-attribute instance-attribute

border: Border | None = None

A border to draw above the background bgcolor, gradient, and image.

border_radius class-attribute instance-attribute

border_radius: BorderRadiusValue | None = None

The border radius of the box.

gradient class-attribute instance-attribute

gradient: Gradient | None = None

A gradient to use when filling the box.

image class-attribute instance-attribute

image: DecorationImage | None = None

An image to paint above the background bgcolor or gradient.

shadows class-attribute instance-attribute

shadows: BoxShadowValue | None = None

A list of shadows cast by the box.

shape class-attribute instance-attribute

shape: BoxShape = RECTANGLE

The shape to fill the bgcolor, gradient, and image into and to cast as the shadows.

Methods

copy

copy(
    *,
    bgcolor: ColorValue | None = None,
    image: DecorationImage | None = None,
    border: Border | None = None,
    border_radius: BorderRadiusValue | None = None,
    shadows: BoxShadowValue | None = None,
    gradient: Gradient | None = None,
    shape: BoxShape | None = None,
    blend_mode: BlendMode | None = None,
)