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(Optional[ColorValue]) –

  The color to fill in the background of the box.

• blend_mode(Optional[BlendMode]) –

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

• border(Optional[Border]) –

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

• border_radius(Optional[BorderRadiusValue]) –

  The border radius of the box.

• gradient(Optional[Gradient]) –

  A gradient to use when filling the box.

• image(Optional[DecorationImage]) –

  An image to paint above the background bgcolor or gradient.

• shadows(Optional[BoxShadowValue]) –

  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: Optional[ColorValue] = None

The color to fill in the background of the box.

blend_mode class-attribute instance-attribute

blend_mode: Optional[BlendMode] = None

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

border class-attribute instance-attribute

border: Optional[Border] = None

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

border_radius class-attribute instance-attribute

border_radius: Optional[BorderRadiusValue] = None

The border radius of the box.

gradient class-attribute instance-attribute

gradient: Optional[Gradient] = None

A gradient to use when filling the box.

image class-attribute instance-attribute

image: Optional[DecorationImage] = None

An image to paint above the background bgcolor or gradient.

shadows class-attribute instance-attribute

shadows: Optional[BoxShadowValue] = 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: Optional[ColorValue] = None,
    image: Optional[DecorationImage] = None,
    border: Optional[Border] = None,
    border_radius: Optional[BorderRadiusValue] = None,
    shadows: Optional[BoxShadowValue] = None,
    gradient: Optional[Gradient] = None,
    shape: Optional[BoxShape] = None,
    blend_mode: Optional[BlendMode] = None,
)