mask

The mask CSS property is shorthand for mask-image, mask-position, mask-size, mask-repeat, mask-origin, mask-clip, mask-composite, and mask-mode.

Syntax

CSS

mask: value;

JS

object.style.mask = "value";

Values

<'mask'> = <mask-layer>#

<mask-layer> = <mask-reference> || <position> [ / <bg-size> ]? ||<repeat-style> || <geometry-box> || [ <geometry-box> | no-clip ] || <compositing-operator> || <masking-mode>

<mask-reference> = none | <image> | <mask-source>

none

A transparent black image layer.

<image> = <url> | <gradient>

<url> = url( <string> <url-modifier>* )

<string>

Specifies a sequence of characters delimited by double quotes (") or single quotes (').

<url-modifier>

Changes the meaning or the interpretation of the URL.

<gradient> = <linear-gradient()> | <repeating-linear-gradient()> | <radial-gradient()> | <repeating-radial-gradient()>

<linear-gradient()> = linear-gradient( [ <angle> | to <side-or-corner> ]? , <color-stop-list> )

<angle>

deg

Degrees. There are 360 degrees in a full circle.

grad

Gradians, also known as "gons" or "grades". There are 400 gradians in a full circle.

rad

Radians. There are 2p radians in a full circle.

turn

Turns. There is 1 turn in a full circle.

<side-or-corner> = [left | right] || [top | bottom]

left

Left.

right

Right.

top

Top.

bottom

Bottom.

<color-stop-list> = <linear-color-stop> , [ <linear-color-hint>? , <linear-color-stop> ]#

<linear-color-stop> = <color> && <length-percentage>?

<color>

Specifies the color using a keyword or a numerical specification.

<length-percentage> = [ <length> | <percentage> ]

<length>

Specifies the length using a number followed by a unit of measurement.

<percentage>

Specifies the percentage using a number followed by a percent sign (%).

<linear-color-hint> = <length-percentage>

<length-percentage> = [ <length> | <percentage> ]

<length>

Specifies the length using a number followed by a unit of measurement.

<percentage>

Specifies the percentage using a number followed by a percent sign (%).

<repeating-linear-gradient()> = linear-gradient( [ <angle> | to <side-or-corner> ]? , <color-stop-list> )

<angle>

deg

Degrees. There are 360 degrees in a full circle.

grad

Gradians, also known as "gons" or "grades". There are 400 gradians in a full circle.

rad

Radians. There are 2p radians in a full circle.

turn

Turns. There is 1 turn in a full circle.

<side-or-corner> = [left | right] || [top | bottom]

left

Left.

right

Right.

top

Top.

bottom

Bottom.

<color-stop-list> = <linear-color-stop> , [ <linear-color-hint>? , <linear-color-stop> ]#

<linear-color-stop> = <color> && <length-percentage>?

<color>

Specifies the color using a keyword or a numerical specification.

<length-percentage> = [ <length> | <percentage> ]

<length>

Specifies the length using a number followed by a unit of measurement.

<percentage>

Specifies the percentage using a number followed by a percent sign (%).

<linear-color-hint> = <length-percentage>

<length-percentage> = [ <length> | <percentage> ]

<length>

Specifies the length using a number followed by a unit of measurement.

<percentage>

Specifies the percentage using a number followed by a percent sign (%).

<radial-gradient()> = radial-gradient( [ <ending-shape> || <size> ]? [ at <position> ]? , <color-stop-list> )

<ending-shape>

Determines whether the gradient's ending shape is a circle or an ellipse.

<size>

Determines the size of the gradient's ending shape.

<position> = [ [ left | center | right ] || [ top | center | bottom ] | [ left | center | right | <length-percentage> ] [ top | center | bottom | <length-percentage> ]? | [ [ left | right ] <length-percentage> ] && [ [ top | bottom ] <length-percentage> ] ]

left

Left.

center

Center.

right

Right.

top

Top.

bottom

Bottom.

<length-percentage> = [ <length> | <percentage> ]

<length>

Specifies the length using a number followed by a unit of measurement.

<percentage>

Specifies the percentage using a number followed by a percent sign (%).

<color-stop-list> = <linear-color-stop> , [ <linear-color-hint>? , <linear-color-stop> ]#

<linear-color-stop> = <color> && <length-percentage>?

<color>

Specifies the color using a keyword or a numerical specification.

<length-percentage> = [ <length> | <percentage> ]

<length>

Specifies the length using a number followed by a unit of measurement.

<percentage>

Specifies the percentage using a number followed by a percent sign (%).

<linear-color-hint> = <length-percentage>

<length-percentage> = [ <length> | <percentage> ]

<length>

Specifies the length using a number followed by a unit of measurement.

<percentage>

Specifies the percentage using a number followed by a percent sign (%).

<repeating-radial-gradient()> = radial-gradient( [ <ending-shape> || <size> ]? [ at <position> ]? , <color-stop-list> )

<ending-shape>

Determines whether the gradient's ending shape is a circle or an ellipse.

<size>

Determines the size of the gradient's ending shape.

<position> = [ [ left | center | right ] || [ top | center | bottom ] | [ left | center | right | <length-percentage> ] [ top | center | bottom | <length-percentage> ]? | [ [ left | right ] <length-percentage> ] && [ [ top | bottom ] <length-percentage> ] ]

left

Left.

center

Center.

right

Right.

top

Top.

bottom

Bottom.

<length-percentage> = [ <length> | <percentage> ]

<length>

Specifies the length using a number followed by a unit of measurement.

<percentage>

Specifies the percentage using a number followed by a percent sign (%).

<color-stop-list> = <linear-color-stop> , [ <linear-color-hint>? , <linear-color-stop> ]#

<linear-color-stop> = <color> && <length-percentage>?

<color>

Specifies the color using a keyword or a numerical specification.

<length-percentage> = [ <length> | <percentage> ]

<length>

Specifies the length using a number followed by a unit of measurement.

<percentage>

Specifies the percentage using a number followed by a percent sign (%).

<linear-color-hint> = <length-percentage>

<length-percentage> = [ <length> | <percentage> ]

<length>

Specifies the length using a number followed by a unit of measurement.

<percentage>

Specifies the percentage using a number followed by a percent sign (%).

<mask-source> = <url>

<url> = url( <string> <url-modifier>* )

<string>

Specifies a sequence of characters delimited by double quotes (") or single quotes (').

<url-modifier>

Changes the meaning or the interpretation of the URL.

<position> = [ [ left | center | right ] || [ top | center | bottom ] | [ left | center | right | <length-percentage> ] [ top | center | bottom | <length-percentage> ]? | [ [ left | right ] <length-percentage> ] && [ [ top | bottom ] <length-percentage> ] ]

left

Left.

center

Center.

right

Right.

top

Top.

bottom

Bottom.

<length-percentage> = [ <length> | <percentage> ]

<length>

Specifies the length using a number followed by a unit of measurement.

<percentage>

Specifies the percentage using a number followed by a percent sign (%).

<bg-size> = [ <length-percentage [0,∞]> | auto ]{1,2} | cover | contain

<length-percentage> = [ <length> | <percentage> ]

<length>

Specifies the length using a number followed by a unit of measurement.

<percentage>

Specifies the percentage using a number followed by a percent sign (%).

auto

Automatically specified by the user agent.

cover

Scale the image, while preserving its intrinsic aspect ratio (if any), to the smallest size such that both its width and its height can completely cover the background positioning area.

contain

Scale the image, while preserving its intrinsic aspect ratio (if any), to the largest size such that both its width and its height can fit inside the background positioning area.

<repeat-style> = repeat-x | repeat-y | [repeat | space | round | no-repeat]{1,2}

repeat-x

The image is repeated in the horizontal direction as often as needed to cover the background painting area.

repeat-y

The image is repeated in the vertical direction as often as needed to cover the background painting area.

repeat

The image is repeated in the horizontal and vertical direction as often as needed to cover the background painting area.

space

The image is repeated as often as will fit within the background positioning area without being clipped and then the images are spaced out to fill the area.

round

The image is repeated as often as will fit within the background positioning area. If it doesn't fit a whole number of times, it is rescaled so that it does.

no-repeat

The image is placed once and not repeated in this direction.

<geometry-box> = <shape-box> | fill-box | stroke-box | view-box

<shape-box> = <box> | margin-box

<box> = border-box | padding-box | content-box

border-box

Area within the border box.

padding-box

Area within the padding box.

content-box

Area within the content box.

margin-box

Area within the margin box.

fill-box

Uses the object bounding box as a reference box.

stroke-box

Uses the stroke bounding box as a reference box.

view-box

Uses the nearest SVG viewport as a reference box.

no-clip

The painted content is not restricted (not clipped).

<compositing-operator> = add | subtract | intersect | exclude

add

The source is placed over the destination.

subtract

The source is placed, where it falls outside of the destination.

intersect

The parts of source that overlap the destination, replace the destination.

exclude

The non-overlapping regions of source and destination are combined.

<masking-mode> = alpha | luminance | match-source

alpha

Indicates the alpha values of the mask layer image should be used as the mask values.

luminance

Indicates the luminance values of the mask layer image should be used as the mask values.

match-source

The value specified by the referenced mask element's mask-type property must be used.

<!doctype html>
<html>
<head>
    <style>
        div {
            background-color: yellow;
            border-style: solid;
            border-width: 10px;
            margin: 10px;
            mask-image: url(/assets/png/HappyFace.png);
            mask-origin: margin-box;
            padding: 10px;
        }
    </style>
    <script>
        function mouseover(value) {
            document.getElementsByTagName("div")[0].style.mask = "url(/assets/png/HappyFace.png) margin-box " + value;
        }
    </script>
</head>
<body>
    <input onmouseover="mouseover(value)" type="button" value="border-box">
    <input onmouseover="mouseover(value)" type="button" value="content-box">
    <input onmouseover="mouseover(value)" type="button" value="fill-box">
    <input onmouseover="mouseover(value)" type="button" value="margin-box">
    <input onmouseover="mouseover(value)" type="button" value="no-clip">
    <input onmouseover="mouseover(value)" type="button" value="padding-box">
    <input onmouseover="mouseover(value)" type="button" value="stroke-box">
    <input onmouseover="mouseover(value)" type="button" value="view-box">
    <div>
        mask-clip
        <svg height="100" width="100" viewBox="0 0 100 100">
            <g stroke="black" stroke-width="10">
                <rect fill="yellow" height="100" width="100"/>
            </g>
        </svg>
    </div>
</body>
</html>

JS | mask-composite

JS | mask-image

JS | mask-mode

JS | mask-origin

<!doctype html>
<html>
<head>
    <style>
        div {
            background-color: yellow;
            border-style: solid;
            border-width: 10px;
            margin: 10px;
            mask-image: url(/assets/png/HappyFace.png);
            padding: 10px;
        }
    </style>
    <script>
        function mouseover(value) {
            document.getElementsByTagName("div")[0].style.mask = "url(/assets/png/HappyFace.png) " + value;
        }
    </script>
</head>
<body>
    <input onmouseover="mouseover(value)" type="button" value="border-box">
    <input onmouseover="mouseover(value)" type="button" value="content-box">
    <input onmouseover="mouseover(value)" type="button" value="fill-box">
    <input onmouseover="mouseover(value)" type="button" value="margin-box">
    <input onmouseover="mouseover(value)" type="button" value="padding-box">
    <input onmouseover="mouseover(value)" type="button" value="stroke-box">
    <input onmouseover="mouseover(value)" type="button" value="view-box">
    <div>
        mask-origin
        <svg height="100" width="100" viewBox="0 0 100 100">
            <g stroke="black" stroke-width="10">
                <rect fill="yellow" height="100" width="100"/>
            </g>
        </svg>
    </div>
</body>
</html>

JS | mask-position

<!doctype html>
<html>
<head>
    <style>
        div {
            background-color: yellow;
            height: 100%;
            mask-image: url(/assets/png/HappyFace.png);
            mask-repeat: no-repeat;
        }
    </style>
    <script>
        function mouseover(value) {
            document.getElementsByTagName("div")[0].style.mask = "url(/assets/png/HappyFace.png) " + value + " no-repeat";
        }
    </script>
</head>
<body>
    <button onmouseover="mouseover(value)" value="0% 0%">initial</button>
    <input onmouseover="mouseover(value)" type="button" value="bottom">
    <input onmouseover="mouseover(value)" type="button" value="center">
    <input onmouseover="mouseover(value)" type="button" value="left">
    <button onmouseover="mouseover(value)" value="100px 100px">length</button>
    <button onmouseover="mouseover(value)" value="100% 100%">position</button>
    <input onmouseover="mouseover(value)" type="button" value="right">
    <input onmouseover="mouseover(value)" type="button" value="top">
    <div>mask-position</div>
</body>
</html>

mask

Syntax

CSS

JS

Values

Examples

mask-clip | border-box

mask-clip | content-box

mask-clip | fill-box

mask-clip | margin-box

mask-clip | no-clip

mask-clip | padding-box

mask-clip | stroke-box

mask-clip | view-box

mask-composite | add

mask-composite | exclude

mask-composite | intersect

mask-composite | subtract

mask-image | image | gradient | linear-gradient

mask-image | image | gradient | radial-gradient

mask-image | image | url

mask-image | none

mask-mode | alpha

mask-mode | luminance

mask-mode | match-source

mask-origin | border-box

mask-origin | content-box

mask-origin | fill-box

mask-origin | margin-box

mask-origin | padding-box

mask-origin | stroke-box

mask-origin | view-box

mask-position | bottom

mask-position | center

mask-position | left

mask-position | length

mask-position | percentage

mask-position | right

mask-position | top

mask-repeat | no-repeat

mask-repeat | repeat

mask-repeat | repeat-x

mask-repeat | repeat-y

mask-repeat | round

mask-repeat | space

mask-size | auto

mask-size | contain

mask-size | cover

mask-size | length

mask-size | percentage

JS | mask-clip

JS | mask-composite

JS | mask-image

JS | mask-mode

JS | mask-origin

JS | mask-position

JS | mask-repeat

JS | mask-size

Links

Internal

External