The FCC just voted to kill net neutrality. Congress can still stop it.

CSS Layout API Level 1

Editor’s Draft,

This version:
https://drafts.css-houdini.org/css-layout-api-1/
Latest published version:
https://www.w3.org/TR/css-layout-api-1/
Feedback:
public-houdini@w3.org with subject line “[css-layout-api] … message topic …” (archives)
Issue Tracking:
Inline In Spec
GitHub Issues
Editors:
Tab Atkins-Bittner (Google)
Former Editor:

Abstract

Status of this document

This is a public copy of the editors’ draft. It is provided for discussion only and may change at any moment. Its publication here does not imply endorsement of its contents by W3C. Don’t cite this document other than as work in progress.

GitHub Issues are preferred for discussion of this specification. When filing an issue, please put the text “css-layout-api” in the title, preferably like this: “[css-layout-api] …summary of comment…”. All issues and comments are archived.

This document was produced by the CSS Working Group (part of the Style Activity).

This document was produced by a group operating under the W3C Patent Policy. W3C maintains a public list of any patent disclosures made in connection with the deliverables of the group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains Essential Claim(s) must disclose the information in accordance with section 6 of the W3C Patent Policy.

This document is governed by the 1 February 2018 W3C Process Document.

1. Introduction

This section is not normative.

The layout stage of CSS is responsible for generating and positioning fragments from the box tree.

This specification describes an API which allows developers to layout a box in response to computed style and box tree changes.

2. Layout API Containers

A new alternative value is added to the <display-inside> production: layout(<ident>).

layout()
This value causes an element to generate a layout API container box.

A layout API container is the box generated by an element with a <display-inside> computed value layout().

A layout API container establishes a new layout API formatting context for its contents. This is the same as establishing a block formatting context, except that the layout provided by the author is used instead of the block layout. For example, floats do not intrude into the layout API container, and the layout API container’s margins do not collapse with the margins of its contents.

All inflow children of a layout API container are called layout API children and are laid out using the author defined layout.

Layout API containers form a containing block for their contents exactly like block containers do. [CSS21]

Note: In a future level of the specification there may be a way to override the containing block behaviour.

The overflow property applies to layout API containers. This is discussed in §4.3 Overflow.

As the layout is entirely up to the author, properties which are used in other layout modes (e.g. flex, block) may not apply. For example an author may not respect the margin property on children.

2.1. Layout API Container Painting

Layout API Container children paint exactly the same as inline blocks [CSS21], except that the order in which they are returned from the layout method (via childFragments) is used in place of raw document order, and z-index values other than auto create a stacking context even if position is static.

2.2. Box Tree Transformations

The layout API children can act in different ways depending on the value of layout options' childDisplay (set by layoutOptions on the class).

If the value of layout options' childDisplay is "block" the display value of that child is blockified. This is similar to children of flex containers or grid containers. See [css3-display].

If the value of layout options' childDisplay is "normal", no blockification occurs. Instead children with a <display-outside> computed value of inline (a root inline box) will produce a single LayoutFragment representing each line when layoutNextFragment() is called.

Note: This allows authors to adjust the available inline size of each line, and position each line separately.

Children of a LayoutChild which represents root inline box also have some additional transformations.

In both of the above cases the children become atomic inlines.

Note: User agents would not perform any "inline splitting" or fragmenting when they encounter a block-level box.

Note: In the example below "inline-span" would be represented as a single LayoutChild with both "block" and "float" being atomic inlines.
<span id="inline-span">
  Text
  <div id="block"></div>
  <div id="float"></div>
  Text
</span>

3. Layout API Model and Terminology

This section gives an overview of the Layout API given to authors.

The current layout is the layout algorithm for the box we are currently performing layout for.

The parent layout is the layout algorithm for the box’s direct parent, (the layout algorithm which is requesting the current layout to be performed).

A child layout is the layout algorithm for a LayoutChild of the current layout.

3.1. Layout Children

[Exposed=LayoutWorklet]
interface LayoutChild {
    readonly attribute StylePropertyMapReadOnly styleMap;

    IntrinsicSizesRequest intrinsicSizes();
    LayoutFragmentRequest layoutNextFragment(LayoutConstraints constraints, ChildBreakToken breakToken);
};

The LayoutChild has internal slot(s):


A LayoutChild represents either a CSS generated box before layout has occured. (The box or boxes will all have a computed value of display that is not none).

The LayoutChild does not contain any layout information itself (like inline or block size) but can be used to generate LayoutFragments which do contain layout information.

An author cannot construct a LayoutChild with this API, this happens at a separate stage of the rendering engine (post style resolution).

A LayoutChild could be generated by:

Note: As an example the following would be placed into three LayoutChildren:
<style>
  #box::before { content: 'hello!'; }
</style>
<div id="box">A block level box with text.</div>
<img src="..." />
Note: As an example the following would be placed into a single LayoutChild as they share a root inline box:
This is a next node, <span>with some additional styling,
that may</span> break over<br>multiple lines.

Multiple non-atomic inlines are placed within the same LayoutChild to allow rendering engines to perform text shaping across element boundaries.

Note: As an example the following should produce one LayoutFragment but is from three non-atomic inlines:
ع<span style="color: blue">ع</span>ع

An array of LayoutChildren is passed into the layout method which represents the children of the current box which is being laid out.

The styleMap, on getting from a LayoutChild this, the user agent must perform the following steps:
  1. Return thisStylePropertyMapReadOnly contained in the [[styleMap]] internal slot.

When the layoutNextFragment(constraints, breakToken) method is called on a LayoutChild this, the user agent must perform the following steps:
  1. Let request be a new LayoutFragmentRequest with internal slot(s):

  2. Return request.

When the intrinsicSizes() method is called on a LayoutChild this, the user agent must perform the following steps:
  1. Let request be a new IntrinsicSizesRequest with internal slot(s):

  2. Return request.

Note: Both layoutNextFragment() and intrinsicSizes() don’t synchronously run. See §5.5.1 Request Objects for a full description.

3.1.1. LayoutChildren and the Box Tree

Each box has a [[layoutChildMap]] internal slot, which is a map of LayoutWorkletGlobalScopes to LayoutChildren.

When the user agent wants to get a layout child given workletGlobalScope, name, and box, it must run the following steps:
  1. Assert that:

  2. Let layoutChildMap be box’s [[layoutChildMap]].

  3. If layoutChildMap[workletGlobalScope] does not exist, run the following steps:

    1. Let definition be the result of get a layout definition given name, and workletGlobalScope.

      Assert that get a layout definition succeeded, and definition is not "invalid".

    2. Let childInputProperties be definition’s child input properties.

    3. Let layoutChild be a new LayoutChild with internal slot(s):

    4. Set layoutChildMap[workletGlobalScope] to layoutChild.

  4. Return the result of get layoutChildMap[workletGlobalScope]

When a box is inserted into the box tree the user agent may pre-populate the [[layoutChildMap]] for all LayoutWorkletGlobalScopes.

When a box is removed from the box tree the user agent must clear the [[layoutChildMap]].

When the user agent wants to update a layout child style given box, it must run the following steps:
  1. Assert that:

    • box is currently attached to the box tree.

  2. If box’s containing block is not a layout API container, abort all these steps.

  3. Let layoutChildMap be box’s [[layoutChildMap]].

  4. For each layoutChild in layoutChildMap:

    1. Let styleMap be layoutChild’s [[styleMap]].

    2. Update styleMap’s declarations based on the box’s new computed style.

When the computed style of a box changes the user agent must run the update a layout child style algorithm.

3.2. Layout Fragments

[Exposed=LayoutWorklet]
interface LayoutFragment {
    readonly attribute double inlineSize;
    readonly attribute double blockSize;

    attribute double inlineOffset;
    attribute double blockOffset;

    readonly attribute any data;

    readonly attribute ChildBreakToken? breakToken;
};

The LayoutFragment has internal slot(s):


A LayoutFragment represents a CSS fragment of a LayoutChild after layout has occurred on that child. This is produced by the layoutNextFragment() method.

The LayoutFragment has inlineSize and blockSize attributes, which are set by the respective child’s layout algorithm. They represent the border box size of the CSS fragment, and are relative to the current layout’s writing mode.

The inlineSize and blockSize attributes cannot be changed. If the current layout requires a different inlineSize or blockSize the author must perform layoutNextFragment() again with different arguments in order to get different results.

The author inside the current layout can position a resulting LayoutFragment by setting its inlineOffset and blockOffset attributes. If not set by the author they default to zero. The inlineOffset and blockOffset attributes represent the position of the LayoutFragment relative to its parent’s border box, before transform or positioning (e.g. if a fragment is relatively positioned) has been applied.

The layout algorithm performs a block-like layout (positioning fragments sequentially in the block direction), while centering its children in the inline direction.
registerLayout('block-like', class {
    *intrinsicSizes(children, edges, styleMap) {
      const childrenSizes = yield children.map((child) => {
          return child.intrinsicSizes();
      });

      const maxContentSize = childrenSizes.reduce((max, childSizes) => {
          return Math.max(max, childSizes.maxContentSize);
      }, 0) + edges.all.inline;

      const minContentSize = childrenSizes.reduce((max, childSizes) => {
          return Math.max(max, childSizes.minContentSize);
      }, 0) + edges.all.inline;

      return {maxContentSize, minContentSize};
    }

    *layout(children, edges, constraints, styleMap) {
        const availableInlineSize = constraints.fixedInlineSize - edges.all.inline;
        const availableBlockSize = (constraints.fixedBlockSize || Infinity) - edges.all.block;

        const childFragments = [];
        const childConstraints = { availableInlineSize, availableBlockSize };

        const childFragments = yield children.map((child) => {
            return child.layoutNextFragment(childConstraints);
        });

        let blockOffset = edges.all.blockStart;
        for (let fragment of childFragments) {
            // Position the fragment in a block like manner, centering it in the
            // inline direction.
            fragment.blockOffset = blockOffset;
            fragment.inlineOffset = Math.max(
                edges.all.inlineStart,
                (availableInlineSize - fragment.inlineSize) / 2);

            blockOffset += fragment.blockSize;
        }

        const autoBlockSize = blockOffset + edges.all.blockEnd;

        return {
            autoBlockSize,
            childFragments,
        };
    }
});

A layout API container can communicate with other layout API containers by using the data attribute. This is set by the data member in the FragmentResultOptions dictionary.

The LayoutFragment's breakToken specifies where the LayoutChild last fragmented. If the breakToken is null the LayoutChild wont produce any more LayoutFragments for that token chain. The breakToken can be passed to the layoutNextFragment() function to produce the next LayoutFragment for a particular child. The breakToken cannot be changed. If the current layout requires a different breakToken the author must perform layoutNextFragment() again with different arguments.

When the user agent wants to create a layout fragment given generator, layoutFragmentRequest, and internalFragment, it must run the following steps:
  1. Let targetRealm be generator’s Realm.

  2. Let fragment be a new LayoutFragment with:

  3. Return fragment.

3.3. Intrinsic Sizes

[Exposed=LayoutWorklet]
interface IntrinsicSizes {
  readonly attribute double minContentSize;
  readonly attribute double maxContentSize;
};

The IntrinsicSizes object has internal slot(s):


A IntrinsicSizes object represents the min-content size and max-content size of a CSS box. It has minContentSize and maxContentSize attributes which represent the border box min/max-content contribution of the LayoutChild for the current layout. The attributes are relative to the inline direction of the current layout’s writing mode.

The minContentSize and maxContentSize cannot be changed. They must not change for a LayoutChild within the current layout pass.

The example below shows the border-box intrinsic sizes of two children.
<style>
.child-0 {
  width: 380px;
  border: solid 10px;
}

.child-1 {
  border: solid 5px;
}

.box {
  display: layout(intrinsic-sizes-example);
  font: 25px/1 Ahem;
}
</style>

<div class="box">
  <div class="child-0"></div>
  <div class="child-1">XXX XXXX</div>
</div>
registerLayout('intrinsic-sizes-example', class {
    *intrinsicSizes(children, edges, styleMap) {
      const childrenSizes = yield children.map((child) => {
          return child.intrinsicSizes();
      });

      childrenSizes[0].minContentSize; // 400, (380+10+10) child has a fixed size.
      childrenSizes[0].maxContentSize; // 400, (380+10+10) child has a fixed size.

      childrenSizes[1].minContentSize; // 100, size of "XXXX".
      childrenSizes[1].maxContentSize; // 200, size of "XXX XXXX".
    }

    *layout() {}
});
When the user agent wants to create an intrinsic sizes object given intrinsicSizesRequest, and internalIntrinsicSizes, it must run the following steps:
  1. Let intrinsicSizes be a new IntrinsicSizes with:

  2. Return intrinsicSizes.

3.4. Layout Constraints

[Constructor(optional LayoutConstraintsOptions options),Exposed=LayoutWorklet]
interface LayoutConstraints {
    readonly attribute double availableInlineSize;
    readonly attribute double availableBlockSize;

    readonly attribute double? fixedInlineSize;
    readonly attribute double? fixedBlockSize;

    readonly attribute double percentageInlineSize;
    readonly attribute double percentageBlockSize;

    readonly attribute double? blockFragmentationOffset;
    readonly attribute BlockFragmentationType blockFragmentationType;

    readonly attribute any data;
};

dictionary LayoutConstraintsOptions {
    double availableInlineSize = 0;
    double availableBlockSize = 0;

    double fixedInlineSize;
    double fixedBlockSize;

    double percentageInlineSize;
    double percentageBlockSize;

    double blockFragmentationOffset;
    BlockFragmentationType blockFragmentationType = "none";

    any data;
};

enum BlockFragmentationType { "none", "page", "column", "region" };

A LayoutConstraints object is passed into the layout method which represents the all the constraints for the current layout to perform layout inside. It is also used to pass information about the available space into a child layout.

The LayoutConstraints object has availableInlineSize and availableBlockSize attributes. This represents the available space for a LayoutFragment which the layout should respect.

Note: Some layouts may need to produce a LayoutFragment which exceed this size. For example a replaced element. The parent layout should expect this to occur and deal with it appropriately.

A parent layout may require the current layout to be exactly a particular size. If the fixedInlineSize or fixedBlockSize are specified the current layout should produce a LayoutFragment with a the specified size in the appropriate direction.

The layout algorithm performs a flexbox-like distribution of spare space in the inline direction. It creates child layout constraints which specify that a child should be a fixed inline size.
registerLayout('flex-distribution-like', class {
    *intrinsicSizes(children, edges, styleMap) {
      const childrenSizes = yield children.map((child) => {
          return child.intrinsicSizes();
      });

      const maxContentSize = childrenSizes.reduce((sum, childSizes) => {
          return sum + childSizes.maxContentSize;
      }, 0) + edges.all.inline;

      const minContentSize = childrenSizes.reduce((max, childSizes) => {
          return sum + childSizes.minContentSize;
      }, 0) + edges.all.inline;

      return {maxContentSize, minContentSize};
    }

    *layout(children, edges, constraints, styleMap) {

        const availableInlineSize =
            constraints.fixedInlineSize - edges.all.inline;
        const availableBlockSize =
            (constraints.fixedInlineSize || Infinity) - edges.all.block;

        const childConstraints = { availableInlineSize, availableBlockSize };

        const unconstrainedChildFragments = yield children.map((child) => {
            return child.layoutNextFragment(childConstraints);
        });

        const unconstrainedSizes = [];
        const totalSize = unconstrainedChildFragments.reduce((sum, fragment, i) => {
            unconstrainedSizes[i] = fragment.inlineSize;
            return sum + fragment.inlineSize;
        }, 0);

        // Distribute spare space between children.
        const remainingSpace = Math.max(0, inlineSize - totalSize);
        const extraSpace = remainingSpace / children.length;

        const childFragments = yield children.map((child, i) => {
            return child.layoutNextFragment({
                fixedInlineSize: unconstrainedSizes[i] + extraSpace,
                availableBlockSize
            });
        });

        // Position the fragments.
        let inlineOffset = 0;
        let maxChildBlockSize = 0;
        for (let fragment of childFragments) {
            fragment.inlineOffset = inlineOffset;
            fragment.blockOffset = edges.all.blockStart;

            inlineOffset += fragment.inlineSize;
            maxChildBlockSize = Math.max(maxChildBlockSize, fragment.blockSize);
        }

        return {
            autoBlockSize: maxChildBlockSize + edges.all.block,
            childFragments,
        };
    }
});

The LayoutConstraints object has percentageInlineSize and percentageBlockSize attributes. These represent the size that a layout percentages should be resolved against while performing layout.

The LayoutConstraints has a blockFragmentationType attribute. The current layout should produce a LayoutFragment which fragments at the blockFragmentationOffset if possible.

The current layout can choose not to fragment a LayoutChild based on the blockFragmentationType, for example if the child has a property like break-inside: avoid-page;.

When the user agent wants to create a layout constraints object given sizingMode, box|, and internalLayoutConstraints, it must run the following steps:
  1. If sizingMode is "block-like" then:

    1. Let fixedInlineSize be the result of calculating box’s border-box inline size (relative to box’s writing mode) exactly like block containers do.

    2. Let fixedBlockSize be null if box’s block size is auto, otherwise the result of calculating box’s border-box block size exactly like block containers do.

    3. Return a new LayoutConstraints object with:

  2. If sizingMode is "manual" then:

    1. Return a new LayoutConstraints object with:

3.5. Breaking and Fragmentation

[Exposed=LayoutWorklet]
interface ChildBreakToken {
    readonly attribute BreakType breakType;
    readonly attribute LayoutChild child;
};

[Exposed=LayoutWorklet]
interface BreakToken {
    readonly attribute FrozenArray<ChildBreakToken> childBreakTokens;
    readonly attribute any data;
};

dictionary BreakTokenOptions {
    sequence<ChildBreakToken> childBreakTokens;
    any data = null;
};

enum BreakType { "none", "line", "column", "page", "region" };

A LayoutChild can produce multiple LayoutFragments. A LayoutChild may fragment in the block direction if a blockFragmentationType is not none. Additionally LayoutChild which represents inline-level content, may fragment line by line if the layout options' childDisplay (set by layoutOptions) is "normal".

A subsequent LayoutFragment is produced by using the previous LayoutFragment's breakToken. This tells the child layout to produce a LayoutFragment starting at the point encoded in the ChildBreakToken.

This example shows a simple layout which indents child fragments for a certain number of lines.

This example also demonstrates using the previous breakToken of a LayoutFragment to produce the next fragment for the LayoutChild.

It also demonstrates using the BreakToken to respect the LayoutConstraints' blockFragmentationType, it resumes it layout from the previous BreakToken. It returns a FragmentResultOptions with a breakToken which is used to resume the layout.

registerLayout('indent-lines', class {
    static layoutOptions = {childDisplay: 'normal'};
    static inputProperties = ['--indent', '--indent-lines'];

    *layout(children, edges, constraints, styleMap, breakToken) {

        // Determine our (inner) available size.
        const availableInlineSize =
            constraints.fixedInlineSize - edges.all.inline;
        const availableBlockSize =
            (constraints.fixedBlockSize || Infinity) - edges.all.block;

        // Detrermine the number of lines to indent, and the indent amount.
        const indent = resolveLength(constraints, styleMap.get('--indent'));
        let lines = styleMap.get('--indent-lines').value;

        const childFragments = [];

        let childBreakToken = null;
        if (breakToken) {
            childBreakToken = breakToken.childBreakTokens[0];

            // Remove all the children we have already produced fragments for.
            children.splice(0, children.indexOf(childBreakToken.child));
        }

        let blockOffset = edges.all.blockStart;
        let child = children.shift();
        while (child) {
            const shouldIndent = lines-- > 0;

            // Adjust the inline size for the indent.
            const childAvailableInlineSize = shouldIndent ?
                availableInlineSize - indent : availableInlineSize;

            const childConstraints = {
                availableInlineSize: childAvailableInlineSize,
                availableBlockSize,
                percentageInlineSize: availableInlineSize,
                blockFragmentationType: constraints.blockFragmentationType,
            };

            const fragment = yield child.layoutNextFragment(childConstraints,
                                                            childBreakToken);
            childFragments.push(fragment);

            // Position the fragment.
            fragment.inlineOffset = shouldIndent ?
                edges.all.inlineStart + indent : edges.all.inlineStart;
            fragment.blockOffset = blockOffset;
            blockOffset += fragment.blockSize;

            // Check if we have gone over the block fragmentation limit.
            if (constraints.blockFragmentationType != 'none' &&
                blockOffset > constraints.blockSize) {
                break;
            }

            if (fragment.breakToken) {
                childBreakToken = fragment.breakToken;
            } else {
                // If a fragment doesn’t have a break token, we move onto the
                // next child.
                child = children.shift();
                childBreakToken = null;
            }
        }

        const autoBlockSize = blockOffset + edges.all.blockEnd;

        // Return our fragment.
        const result = {
            autoBlockSize,
            childFragments: childFragments,
        }

        if (childBreakToken) {
            result.breakToken = {
                childBreakTokens: [childBreakToken],
            };
        }

        return result;
    }
});

3.6. Edges

[Exposed=LayoutWorklet]
interface LayoutEdgeSizes {
  readonly attribute double inlineStart;
  readonly attribute double inlineEnd;

  readonly attribute double blockStart;
  readonly attribute double blockEnd;

  // Convenience attributes for the sum in one direction.
  readonly attribute double inline;
  readonly attribute double block;
};

[Exposed=LayoutWorklet]
interface LayoutEdges {
  readonly attribute LayoutEdgeSizes border;
  readonly attribute LayoutEdgeSizes scrollbar;
  readonly attribute LayoutEdgeSizes padding;

  readonly attribute LayoutEdgeSizes all;
};

A LayoutEdges object is passed into the layout method. This represents the size of the box model edges for the current box which is being laid out.

The LayoutEdges has border, scrollbar, and padding attributes. Each of these represent the width of their respective edge.

The LayoutEdges has the all attribute. This is a convenience attribute which represents the sum of the border, scrollbar, padding edges.

The LayoutEdgeSizes object represents the width in CSS pixels of an edge in each of the abstract dimensions (inlineStart, inlineEnd, blockStart, blockEnd).

The inline, and block on the LayoutEdgeSizes object are convenience attributes which represent the sum in that direction.

This example shows an node styled by CSS, and what its respective LayoutEdges could contain.
<style>
.container {
  width: 50px;
  height: 50px;
}

.box {
  display: layout(box-edges);

  padding: 10%;
  border: solid 2px;
  overflow-y: scroll;
}
</style>

<div class="container">
  <div class="box"></div>
</div>
registerLayout('box-edges', class {
    *layout(children, edges, constraints, styleMap, breakToken) {
        edges.padding.inlineStart; // 5 (as 10% * 50px = 5px).
        edges.border.blockEnd; // 2
        edges.scrollbar.inlineEnd; // UA-dependent, may be 0 or >0 (e.g. 16).
        edges.all.block; // 14 (2 + 5 + 5 + 2).
    }
}

4. Interactions with other Modules

This section describes how other CSS modules interact with the CSS Layout API.

4.1. Sizing

User agents must use the LayoutConstraints object to communicate to the current layout the size they would like the fragment to be.

If the user agent wishes to force a size on the box, it can use the fixedInlineSize and fixedBlockSize attributes to do so.

The layout API container can be passed size information in different ways depending on the value of layout options' sizing (set by layoutOptions on the class).

If the value of layout options' sizing is "block-like", then the LayoutConstraints passed to the layout API container:

If the value of layout options' sizing is "manual", then the user-agent must not pre-calculate fixedInlineSize and/or fixedBlockSize ahead of time, except when it is being forced to a particular size by the formatting context in which it participates, for example:

Note: In the example below the layout API container has its inline size set to 50.
<style>
  #container {
    width: 100px;
    height: 100px;
    box-sizing: border-box;
    padding: 5px;
  }
  #layout-api {
    display: layout(foo);
    margin: 0 20px;
  }
</style>
<div id="container">
  <div id="layout-api"></div>
</div>

4.1.1. Positioned layout sizing

If a layout API container is out-of-flow positioned the user agent must solve the positioned size equations (CSS Positioned Layout 3 §8.1 The width of absolute or fixed positioned, non-replaced elements, CSS Positioned Layout 3 §8.3 The height of absolute or fixed positioned, non-replaced elements), and set the appropriate fixedInlineSize and fixedBlockSize.

Note: In the example below the layout API container has its inline and block size fixed to 80.
<style>
  #container {
    position: relative;
    width: 100px;
    height: 100px;
  }
  #layout-api {
    display: layout(foo);
    top: 10px;
    bottom: 10px;
    left: 10px;
    right: 10px;
    position: absolute;
  }
</style>
<div id="container">
  <div id="layout-api"></div>
</div>

4.2. Positioning

All positioning in this level of the specification is handled by the user agent.

As a result:

Note: In the example below:
<style>
  #container {
    display: layout(foo);
    position: relative; /* container is a containing block */
    width: 100px;
    height: 100px;
  }
  #child-relative {
    position: relative;
    left: 5px;
    top: 10px;
  }
</style>
<div id="container">
  <div id="child-relative"></div>
  <div id="child-absolute"></div>
</div>

4.3. Overflow

The scrollable overflow for a layout API container is handled by the user agent in this level of the specification.

A layout API container should calculate its scrollable overflow exactly like block containers do.

Even if the author’s layout API container positions a fragment into the scrollable overflow region, relative positioning or transforms may cause the fragment to shift such that its scrollable overflow region, causing no overflow to occur.

4.4. Fragmentation

A parent layout can ask the current layout to fragment by setting the blockFragmentationType and blockFragmentationOffset.

E.g. [css-multicol-1] layout would set a blockFragmentationType to "column" and set the blockFragmentationOffset to where it needs the child to fragment.

4.5. Alignment

The first/last baseline sets of a layout API container is generated exactly like block containers do (see CSS Box Alignment 3 §9.1 Determining the Baselines of a Box). Except that the order of the in-flow children should be determined by the in which they are returned form the layout method (via childFragments) instead of the document order.

Note: In a future level of the specification there will be the ability for the author to define the baselines themselves. This will be of the form:

To query baseline information from a LayoutChild.

const fragment = yield child.layoutNextFragment({
  fixedInlineSize: availableInlineSize,
  baselineRequests: ['alphabetic', 'middle'],
});
fragment.baselines.get('alphabetic') === 25 /* or something */;

To produce baseline information for a parent layout:

registerLayout('baseline-producing', class {
  *layout(children, edges, constraints, styleMap) {
    const result = {baselines: {}};

    for (let baselineRequest of constraints.baselineRequests) {
      // baselineRequest === 'alphabetic', or something else.
      result.baselines[baselineRequest] = 25;
    }

    return result;
  }
});

5. Layout

This section describes how the CSS Layout API interacts with the user agent’s layout engine.

5.1. Concepts

A layout definition is a struct which describes the information needed by the LayoutWorkletGlobalScope about the author defined layout (which can be referenced by the layout() function). It consists of:

A document layout definition is a struct which describes the information needed by the document about the author defined layout (which can be referenced by the layout() function). It consists of:

5.2. Layout Invalidation

Each box has an associated layout valid flag. It may be either layout-valid or layout-invalid. It is initially set to layout-invalid.

Each box has an associated intrinsic sizes valid flag. If may be either intrinsic-sizes-valid or intrinsic-sizes-invalid. It is initially set to intrinsic-sizes-invalid.

When the user agent wants to invalidate layout functions given box, the user agent must run the following steps:
  1. Let layoutFunction be the layout() function of the display property on the computed style for the box if it exists. If it is a different type of value (e.g. grid) then abort all these steps.

  2. Let name be the first argument of the layoutFunction.

  3. Let documentDefinition be the result of get a document layout definition given name.

    If get a document layout definition returned failure, or if documentDefinition is "invalid", then abort all these steps.

  4. Let inputProperties be documentDefinition’s input properties.

  5. Let childInputProperties be documentDefinition’s child input properties.

  6. For each property in inputProperties, if the property’s computed value has changed, set the layout valid flag on the box to layout-invalid, and set the intrinsic sizes valid flag to intrinsic-sizes-invalid.

  7. For each property in childInputProperties, if the property’s computed value has changed, set the layout valid flag on the box to layout-invalid, and set the intrinsic sizes valid flag to intrinsic-sizes-invalid.

Invalidate layout functions must be run when the user agent recalculates the computed style for a box, or when the children’s computed style of that box is recalculated.

When a child box represented by a LayoutChild is added or removed from the box tree or has its layout invalidated (from a computed style change, or a descendant change), and this invalidation is to be propagated up the box tree, set the layout valid flag on the current box to layout-invalid and set the intrinsic sizes valid flag on the current box to intrinsic-sizes-invalid.

When the computed style of a layout API container changes, and this change effects the values inside the LayoutEdges object, set the layout valid flag of the box to layout-invalid, and set the intrinsic sizes valid flag of the box to intrinsic-sizes-invalid.

If the computed style changes effects the values inside the LayoutConstraints object, just set the intrinsic sizes valid flag of the box to intrinsic-sizes-invalid.

Note: As the LayoutConstraints object is only passed into the layout function there is no need to invalidate the intrinsic sizes.

Note: As an example the following properties could change the LayoutEdges object:

And the following properties could change the LayoutConstraints object:

Note: This only describes layout invalidation as it relates to the CSS Layout API. All boxes conceptually have a layout valid flag and these changes are propagated through the box tree.

5.3. Layout Worklet

The layoutWorklet attribute allows access to the Worklet responsible for all the classes which are related to layout.

The layoutWorklet's worklet global scope type is LayoutWorkletGlobalScope.

partial namespace CSS {
    [SameObject] readonly attribute Worklet layoutWorklet;
};

The LayoutWorkletGlobalScope is the global execution context of the layoutWorklet.

[Global=(Worklet,LayoutWorklet),Exposed=LayoutWorklet]
interface LayoutWorkletGlobalScope : WorkletGlobalScope {
    void registerLayout(DOMString name, VoidFunction layoutCtor);
};

5.4. Registering A Layout

[Exposed=LayoutWorklet]
dictionary LayoutOptions {
  ChildDisplayType childDisplay = "block";
  LayoutSizingMode sizing = "block-like";
};

[Exposed=LayoutWorklet]
enum ChildDisplayType {
    "block",
    "normal",
};

[Exposed=LayoutWorklet]
enum LayoutSizingMode {
    "block-like",
    "manual",
};

The document has a map of document layout definitions. Initially this map is empty; it is populated when registerLayout(name, layoutCtor) is called.

The LayoutWorkletGlobalScope has a map of layout definitions. Initially this map is empty; it is populated when registerLayout(name, layoutCtor) is called.

Each box representing a layout API container has a map of layout class instances. Initially this map is empty; it is populated when the user agent calls either determine the intrinsic sizes or generate a fragment for a box.

When the registerLayout(name, layoutCtor) method is called, the user agent must run the following steps:
  1. If the name is an empty string, throw a TypeError and abort all these steps.

  2. Let layoutDefinitionMap be LayoutWorkletGlobalScope's layout definitions map.

  3. If layoutDefinitionMap[name] exists throw a "InvalidModificationError" DOMException and abort all these steps.

  4. Let inputProperties be an empty sequence<DOMString>.

  5. Let inputPropertiesIterable be the result of Get(layoutCtor, "inputProperties").

  6. If inputPropertiesIterable is not undefined, then set inputProperties to the result of converting inputPropertiesIterable to a sequence<DOMString>. If an exception is thrown, rethrow the exception and abort all these steps.

    Note: The list of CSS properties provided by the input properties getter can either be custom or native CSS properties.

    Note: The list of CSS properties may contain shorthands.

    Note: In order for a layout class to be forwards compatible, the list of CSS properties can also contains currently invalid properties for the user agent. For example margin-bikeshed-property.

  7. Let childInputProperties be an empty sequence<DOMString>.

  8. Let childInputPropertiesIterable be the result of Get(layoutCtor, "childInputProperties").

  9. If childInputPropertiesIterable is not undefined, then set childInputProperties to the result of converting childInputPropertiesIterable to a sequence<DOMString>. If an exception is thrown, rethrow the exception and abort all these steps.

  10. Let layoutOptionsValue be the result of Get(layoutCtor, "layoutOptions").

  11. Let layoutOptions be the result of converting layoutOptionsValue to a LayoutOptions. If an exception is thrown, rethrow the exception and abort all these steps.

  12. If the result of IsConstructor(layoutCtor) is false, throw a TypeError and abort all these steps.

  13. Let prototype be the result of Get(layoutCtor, "prototype").

  14. If the result of Type(prototype) is not Object, throw a TypeError and abort all these steps.

  15. Let intrinsicSizes be the result of Get(prototype, "intrinsicSizes").

  16. If the result of IsCallable(intrinsicSizes) is false, throw a TypeError and abort all these steps.

  17. If intrinsicSizes’s [[FunctionKind]] internal slot is not "generator", throw a TypeError and abort all these steps.

  18. Let layout be the result of Get(prototype, "layout").

  19. If the result of IsCallable(layout) is false, throw a TypeError and abort all these steps.

  20. If layout’s [[FunctionKind]] internal slot is not "generator", throw a TypeError and abort all these steps.

  21. Let definition be a new layout definition with:

  22. Set layoutDefinitionMap[name] to definition.

  23. Queue a task to run the following steps:

    1. Let documentLayoutDefinitionMap be the associated document’s document layout definitions map.

    2. Let documentDefinition be a new document layout definition with:

    3. If documentLayoutDefinitionMap[name] exists, run the following steps:

      1. Let existingDocumentDefinition be the result of get documentLayoutDefinitionMap[name].

      2. If existingDocumentDefinition is "invalid", abort all these steps.

      3. If existingDocumentDefinition and documentDefinition are not equivalent, (that is input properties, child input properties, and layout options are different), then:

        Set documentLayoutDefinitionMap[name] to "invalid".

        Log an error to the debugging console stating that the same class was registered with different inputProperties, childInputProperties, or layoutOptions.

    4. Otherwise, set documentLayoutDefinitionMap[name] to documentDefinition.

Note: The shape of the class should be:
class MyLayout {
    static get inputProperties() { return ['--foo']; }
    static get childrenInputProperties() { return ['--bar']; }
    static get layoutOptions() {
      return {childDisplay: 'normal', sizing: 'block-like'}
    }

    *intrinsicSizes(children, edges, styleMap) {
        // Intrinsic sizes code goes here.
    }

    *layout(children, edges, constraints, styleMap, breakToken) {
        // Layout code goes here.
    }
}

5.5. Layout Engine

Issue: Currently the API is in an iterable generator form. Based on implementation experience, and web developer experience, this may change to promise based API instead. There are both pros and cons to each of these.

Promises

Generator

5.5.1. Request Objects

[Exposed=LayoutWorklet]
interface IntrinsicSizesRequest {
};

[Exposed=LayoutWorklet]
interface LayoutFragmentRequest {
};

typedef (IntrinsicSizesRequest or LayoutFragmentRequest)
    LayoutFragmentRequestOrIntrinsicSizesRequest;

The IntrinsicSizesRequest has internal slot(s):

The LayoutFragmentRequest has internal slot(s):


The layout method and intrinsic sizes method on the author supplied layout class is a generator function instead of a regular javascript function. This is for user-agents to be able to support asynchronous and parallel layout engines.

When an author invokes the layoutNextFragment() method on a LayoutChild the user-agent doesn’t synchronously generate a LayoutFragment to return to the author’s code. Instead it returns a LayoutFragmentRequest. This is a completely opaque object to the author but contains internal slots which encapsulates the layoutNextFragment() method call.

When a LayoutFragmentRequest(s) are yielded from a layout generator object the user-agent’s layout engine may run the algorithm asynchronously with other work, and/or on a different thread of execution. When LayoutFragment(s) have been produced by the engine, the user-agent will "tick" the generator object with the resulting LayoutFragment(s).

The same applies for the intrinsicSizes() method.

An example layout engine written in javascript is shown below.
class LayoutEngine {
  // This function takes the root of the box-tree, a LayoutConstraints object, and a
  // BreakToken to (if paginating for printing for example) and generates a
  // LayoutFragment.
  layoutEntry(rootBox, rootPageConstraints, breakToken) {
    return layoutFragment({
      box: rootBox,
      layoutConstraints: rootPageConstraints,
      breakToken: breakToken,
    });
  }

  // This function takes a LayoutFragmentRequest and calls the appropriate
  // layout algorithm to generate the a LayoutFragment.
  layoutFragment(fragmentRequest) {
    const box = fragmentRequest.layoutChild;
    const algorithm = selectLayoutAlgorithmForBox(box);
    const fragmentRequestGenerator = algorithm.layout(
        fragmentRequest.layoutConstraints,
        box.children,
        box.styleMap,
        fragmentRequest.breakToken);

    let nextFragmentRequest = fragmentRequestGenerator.next();

    while (!nextFragmentRequest.done) {
      // A user-agent may decide to perform layout to generate the fragments in
      // parallel on separate threads. This example performs them synchronously
      // in order.
      let fragments = nextFragmentRequest.value.map(layoutFragment);

      // A user-agent may decide to yield for other work (garbage collection for
      // example) before resuming this layout work. This example just performs
      // layout synchronously without any ability to yield.
      nextFragmentRequest = fragmentRequestGenerator.next(fragments);
    }

    return nextFragmentRequest.value; // Return the final LayoutFragment.
  }
}

5.6. Performing Layout

// This is the final return value from the author defined layout() method.
dictionary FragmentResultOptions {
    double inlineSize = 0;
    double blockSize = 0;
    double autoBlockSize = 0;
    sequence<LayoutFragment> childFragments = [];
    any data = null;
    BreakTokenOptions breakToken = null;
};

dictionary IntrinsicSizesResultOptions {
    double maxContentSize;
    double minContentSize;
};

5.6.1. Determining Intrinsic Sizes

The determine the intrinsic sizes algorithm defines how a user agent is to query the author defined layout for a box’s intrinsic sizes information.

Note: The determine the intrinsic sizes algorithm allows for user agents to cache an arbitary number of previous invocations to reuse.

When the user agent wants to determine the intrinsic sizes of a layout API formatting context for a given box, childBoxes it must run the following steps:
  1. Let layoutFunction be the layout() for the computed value of <display-inside> for box.

  2. If the intrinsic sizes valid flag for the layoutFunction is intrinsic-sizes-valid the user agent may use the intrinsic sizes from the previous invocation. If so it may abort all these steps and use the previous value for the intrinsic sizes.

  3. Set the intrinsic sizes valid flag for the layoutFunction to intrinsic-sizes-valid.

  4. Let name be the first argument of the layoutFunction.

  5. Let documentDefinition be the result of get a document layout definition given name.

    If get a document layout definition returned failure, or if documentDefinition is "invalid", then let box fallback to the flow layout and abort all these steps.

  6. Let workletGlobalScope be a LayoutWorkletGlobalScope from the list of worklet’s WorkletGlobalScopes from the layout Worklet.

    The user agent must have, and select from at least two LayoutWorkletGlobalScopes in the worklet’s WorkletGlobalScopes list, unless the user agent is under memory constraints.

    Note: This is to ensure that authers do not rely on being able to store state on the global object or non-regeneratable state on the class.

    The user agent may also create a WorkletGlobalScope at this time, given the layout Worklet.

  7. Run invoke a intrinsic sizes callback given name, box, childBoxes, and workletGlobalScope optionally in parallel.

    Note: If the user agent runs invoke a intrinsic sizes callback on a thread in parallel, it should select a layout worklet global scope which can be used on that thread.

When the user agent wants to invoke a intrinsic sizes callback given name, box, childBoxes, and workletGlobalScope, it must run the following steps:
  1. Let definition be the result of get a layout definition given name, and workletGlobalScope.

    If get a layout definition returned failure, let the box fallback to the flow layout and abort all these steps.

  2. Let layoutInstance be the result of get a layout class instance given box, definition, workletGlobalScope.

    If get a layout class instance returned failure, let the box fallback to the flow layout and abort all these steps.

  3. Let inputProperties be definition’s input properties.

  4. Let children be a new list.

  5. For each childBox in childBoxes perform the following substeps:

    1. Let layoutChild be the result of get a layout child given workletGlobalScope, name, and childBox.

    2. Append layoutChild to children.

  6. Let edges be a new LayoutEdgeSizes populated with the computed value for all the box model edges for box.

  7. Let styleMap be a new StylePropertyMapReadOnly populated with only the computed values for properties listed in inputProperties for box.

    We may want to store styleMap on box instead, similar to layoutInstance.

  8. At this stage the user agent may re-use the intrinsic sizes from a previous invocation if children, styleMap are equivalent to that previous invocation. If so let the intrinsic sizes the cached intrinsic sizes and abort all these steps.

  9. Let intrinsicSizesGeneratorFunction be definition’s intrinsic sizes generator function.

  10. Let intrinsicSizesGenerator be the result of Invoke(intrinsicSizesGeneratorFunction, layoutInstance, «children, edges, styleMap»).

    If an exception is thrown the let box fallback to the flow layout and abort all these steps.

  11. Let intrinsicSizesValue be the result of run a generator given intrinsicSizesGenerator, and "intrinsic-sizes".

    If run a generator returned failure, then let box fallback to the flow layout and abort all these steps.

  12. Let intrinsicSizes be the result of converting intrinsicSizesValue to a IntrinsicSizesResultOptions. If an exception is thrown, let box fallback to the flow layout and abort all these steps.

  13. Set the intrinsic sizes of box:

5.6.2. Generating Fragments

The generate a fragment algorithm defines how a user agent is to generate a box’s fragment for an author defined layout.

Note: The generate a fragment algorithm allows for user agents to cache an arbitary number of previous invocations to reuse.

When the user agent wants to generate a fragment of a layout API formatting context for a given box, childBoxes, internalLayoutConstraints, and an optional internalBreakToken it must run the following steps:
  1. Let layoutFunction be the layout() for the computed value of <display-inside> for box.

  2. If the layout valid flag for the layoutFunction is layout-valid the user agent may use the intrinsic sizes from the previous invocation. If so it may abort all these steps and use the previous value for the intrinsic sizes.

  3. Set the layout valid flag for the layoutFunction to layout-valid.

  4. Let name be the first argument of the layoutFunction.

  5. Let documentDefinition be the result of get a document layout definition given name.

    If get a document layout definition returned failure, or if documentDefinition is "invalid", then let box fallback to the flow layout and abort all these steps.

  6. Let workletGlobalScope be a LayoutWorkletGlobalScope from the list of worklet’s WorkletGlobalScopes from the layout Worklet.

    The user agent must have, and select from at least two LayoutWorkletGlobalScopes in the worklet’s WorkletGlobalScopes list, unless the user agent is under memory constraints.

    Note: This is to ensure that authers do not rely on being able to store state on the global object or non-regeneratable state on the class.

    The user agent may also create a WorkletGlobalScope at this time, given the layout Worklet.

  7. Run invoke a layout callback given name, box, childBoxes, internalLayoutConstraints, internalBreakToken, and workletGlobalScope optionally in parallel.

    Note: If the user agent runs invoke a intrinsic sizes callback on a thread in parallel, it should select a layout worklet global scope which can be used on that thread.

When the user agent wants to invoke a layout callback given name, box, childBoxes, internalLayoutConstraints, internalBreakToken, and workletGlobalScope, it must run the following steps:
  1. Let definition be the result of get a layout definition given name, and workletGlobalScope.

    If get a layout definition returned failure, let the box fallback to the flow layout and abort all these steps.

  2. Let layoutInstance be the result of get a layout class instance given box, definition, workletGlobalScope.

    If get a layout class instance returned failure, let the box fallback to the flow layout and abort all these steps.

  3. Let sizingMode be definition’s layout options' sizing property.

  4. Let inputProperties be definition’s input properties.

  5. Let children be a new list.

  6. For each childBox in childBoxes perform the following substeps:

    1. Let layoutChild be the result of get a layout child given workletGlobalScope, name, and childBox.

    2. Append layoutChild to children.

  7. Let edges be a new LayoutEdgeSizes populated with the computed value for all the box model edges for box.

  8. Let layoutConstraints be the result of create a layout constraints object given internalLayoutConstraints, box, and sizingMode.

  9. Let styleMap be a new StylePropertyMapReadOnly populated with only the computed values for properties listed in inputProperties for box.

    We may want to store styleMap on box instead, similar to layoutInstance.

  10. Let breakToken be a new BreakToken populated with the appropriate information from internalBreakToken.

    If internalBreakToken is null, let breakToken be null.

  11. At this stage the user agent may re-use a fragment from a previous invocation if children, styleMap, layoutConstraints, breakToken are equivalent to that previous invocation. If so let the fragment output be that cached fragment and abort all these steps.

  12. Let layoutGeneratorFunction be definition’s layout generator function.

  13. Let layoutGenerator be the result of Invoke(layoutGeneratorFunction, layoutInstance, «children, edges, layoutConstraints, styleMap, breakToken»).

    If an exception is thrown the let box fallback to the flow layout and abort all these steps.

  14. Let fragmentValue be the result of run a generator given layoutGenerator, and "layout".

    If run a generator returned failure, then let box fallback to the flow layout and abort all these steps.

  15. Let fragment be the result of converting fragmentValue to a FragmentResultOptions. If an exception is thrown, let box fallback to the flow layout and abort all these steps.

  16. For each childFragment in fragment’s childFragments, perform the following stubsteps:

    1. If childFragment’s [[generator]] internal slot is not equal to layoutGenerator, then let box fallback to the flow layout and abort all these steps.

  17. If sizingMode is "block-like":

    • Then:

      1. Let inlineSize be layoutConstraintsfixedInlineSize. (This value must be set if we are using "block-like" sizing).

      2. Let blockSize be the result of calculating box’s border-box block size (relative to box’s writing mode) exactly like block containers do, given fragment’s autoBlockSize as the "intrinsic height".

    • Otherwise (sizingMode is "manual"):

      1. Let inlineSize be fragment’s inlineSize.

      2. Let blockSize be fragment’s blockSize.

  18. Return a fragment for box with:

5.6.3. Utility Algorithms

The section specifies algorithms common to the determine the intrinsic sizes and generate a fragment algorithms.

When the user agent wants to get a document layout definition given name, it must run the following steps:
  1. Let documentLayoutDefinitionMap be the associated document’s document layout definitions map.

  2. If documentLayoutDefinitionMap[name] does not exist, return failure and abort all these steps.

  3. Return the result of get documentLayoutDefinitionMap[name].

When the user agent wants to get a layout definition given name, and workletGlobalScope, it must run the following steps:
  1. Let layoutDefinitionMap be workletGlobalScope’s layout definitions map.

  2. If layoutDefinitionMap[name] does not exist, run the following steps:

    1. Queue a task to run the following steps:

      1. Let documentLayoutDefinitionMap be the associated document’s document layout definition map.

      2. Set documentLayoutDefinitionMap[name] to "invalid".

      3. The user agent should log an error to the debugging console stating that a class wasn’t registered in all LayoutWorkletGlobalScopes.

    2. Return failure, and abort all these steps.

  3. Return the result of get layoutDefinitionMap[name].

When the user agent wants to get a layout class instance given box, definition, and workletGlobalScope, it must run the following steps:
  1. Let layoutClassInstanceMap be box’s layout class instances map.

  2. Let layoutInstance be the result of get layoutClassInstanceMap[workletGlobalScope]. If layoutInstance is null, run the following steps:

    1. If the constructor valid flag on definition is false, then return failure and abort all these steps.

    2. Let layoutCtor be the class constructor on definition.

    3. Let layoutInstance be the result of Construct(layoutCtor).

      If construct throws an exception, set the definition’s constructor valid flag to false, then return failure and abort all these steps.

    4. Set layoutClassInstanceMap[workletGlobalScope] to layoutInstance.

  3. Return layoutInstance.

When the user agent wants to run a generator given generator, and generatorType, it must run the following steps:
  1. Let done be a boolean initialized to false.

  2. Let nextValue be undefined.

  3. Perform the following substeps until done is true:

    1. Let nextFunction be the result of Get(generator, "next").

    2. If the result of IsCallable(nextFunction) is false, throw a TypeError and abort all these steps.

    3. Let nextResult be the result of calling Invoke(nextFunction, generator, «nextValue»).

      If an exception is thrown return failure, and abort all these steps.

    4. If the result of Type(nextResult) is not Object, throw a TypeError and abort all these steps.

    5. Let requestOrRequests be the result of Get(nextResult|, "value").

    6. Let done be the result of Get(nextResult, "done").

    7. If the result of GetMethod(requestOrRequests, @@iterable) exists then:

      1. Set results to be a new empty list.

      2. Let requests be the result of converting requestOrRequests to a sequence<LayoutFragmentRequestOrIntrinsicSizesRequest>.

        If an exception is thrown, rethrow the exception and abort all these steps.

      3. For each request in requests perform the following substeps:

        1. Let result be the result of produce a generator result given request, generator, generatorType.

        2. Append result to results.

      4. Set nextValue to be results.

      5. Continue.

    8. Let request be the result of converting requestOrRequests to a LayoutFragmentRequestOrIntrinsicSizesRequest.

      If an exception is thrown, rethrow the exception and abort all these steps.

    9. Let result be the result of produce a generator result given request, generator, generatorType.

      If produce a generator result returns failure, return failure, and abort all these steps.

    10. Set nextValue to be result.

    11. Continue.

    The user agent may perform the above loop out of order, and in parallel. The ordering for requests and results however must be consistent.

    Note: This is to allow user agents to run the appropriate layout algorithm on a different thread, or asynchronously (e.g. time slicing layout work with other work). If the user agent performs the loop in parallel, the outside loop has to wait until all the cross thread tasks are complete before calling the generator again. It cannot return partial results to the author.

  4. Return the result of calling Get(nextResult, "value").

When the user agent wants to produce a generator result given request, generator, and generatorType, it must run the following steps:
  1. If request is a IntrinsicSizesRequest then:

    1. Let layoutChild be the result of looking up the internal slot [[layoutChild]] on request.

    2. Let box be the result of looking up the internal slot [[box]] on layoutChild.

    3. If box is not attached to the box tree, return failure and abort all these steps.

      Note: The author may hold onto a LayoutChild from a previous invocation. It is assumed that a box is only ever attached to the box-tree once, and not re-used.

    4. Let internalIntrinsicSizes be the result of the user agent calculating the border box min/max content contribution of box.

    5. Return the result of create an intrinsic sizes object given request, and internalIntrinsicSizes.

  2. If request is a LayoutFragmentRequest and generatorType is "layout" then:

    1. Let layoutChild be result of looking up the internal slot [[layoutChild]] on request.

    2. Let box be the result of looking up the internal slot [[box]] on layoutChild.

    3. If box is not attached to the box tree, return failure and abort all these steps.

      Note: The author may hold onto a LayoutChild from a previous invocation. It is assumed that a box is only ever attached to the box-tree once, and not re-used.

    4. Let childLayoutConstraints be the result of looking up the internal slot [[layoutConstraints]] on request.

    5. Let childBreakToken be the result of looking up the internal slot [[breakToken]] on request.

    6. Let internalFragment be the result of the user agent producing a fragment based on box, childLayoutConstraints, and childBreakToken.

    7. Return the result of create a layout fragment given generator, request, and internalFragment.

  3. Return failure (neither of the above branches was taken).

6. Security Considerations

There are no known security issues introduced by these features.

7. Privacy Considerations

There are no known privacy issues introduced by these features.

Conformance

Document conventions

Conformance requirements are expressed with a combination of descriptive assertions and RFC 2119 terminology. The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in the normative parts of this document are to be interpreted as described in RFC 2119. However, for readability, these words do not appear in all uppercase letters in this specification.

All of the text of this specification is normative except sections explicitly marked as non-normative, examples, and notes. [RFC2119]

Examples in this specification are introduced with the words “for example” or are set apart from the normative text with class="example", like this:

This is an example of an informative example.

Informative notes begin with the word “Note” and are set apart from the normative text with class="note", like this:

Note, this is an informative note.

Advisements are normative sections styled to evoke special attention and are set apart from other normative text with <strong class="advisement">, like this: UAs MUST provide an accessible alternative.

Conformance classes

Conformance to this specification is defined for three conformance classes:

style sheet
A CSS style sheet.
renderer
A UA that interprets the semantics of a style sheet and renders documents that use them.
authoring tool
A UA that writes a style sheet.

A style sheet is conformant to this specification if all of its statements that use syntax defined in this module are valid according to the generic CSS grammar and the individual grammars of each feature defined in this module.

A renderer is conformant to this specification if, in addition to interpreting the style sheet as defined by the appropriate specifications, it supports all the features defined by this specification by parsing them correctly and rendering the document accordingly. However, the inability of a UA to correctly render a document due to limitations of the device does not make the UA non-conformant. (For example, a UA is not required to render color on a monochrome monitor.)

An authoring tool is conformant to this specification if it writes style sheets that are syntactically correct according to the generic CSS grammar and the individual grammars of each feature in this module, and meet all other conformance requirements of style sheets as described in this module.

Partial implementations

So that authors can exploit the forward-compatible parsing rules to assign fallback values, CSS renderers must treat as invalid (and ignore as appropriate) any at-rules, properties, property values, keywords, and other syntactic constructs for which they have no usable level of support. In particular, user agents must not selectively ignore unsupported component values and honor supported values in a single multi-value property declaration: if any value is considered invalid (as unsupported values must be), CSS requires that the entire declaration be ignored.

Implementations of Unstable and Proprietary Features

To avoid clashes with future stable CSS features, the CSSWG recommends following best practices for the implementation of unstable features and proprietary extensions to CSS.

Non-experimental implementations

Once a specification reaches the Candidate Recommendation stage, non-experimental implementations are possible, and implementors should release an unprefixed implementation of any CR-level feature they can demonstrate to be correctly implemented according to spec.

To establish and maintain the interoperability of CSS across implementations, the CSS Working Group requests that non-experimental CSS renderers submit an implementation report (and, if necessary, the testcases used for that implementation report) to the W3C before releasing an unprefixed implementation of any CSS features. Testcases submitted to W3C are subject to review and correction by the CSS Working Group.

Further information on submitting testcases and implementation reports can be found from on the CSS Working Group’s website at http://www.w3.org/Style/CSS/Test/. Questions should be directed to the public-css-testsuite@w3.org mailing list.

Index

Terms defined by this specification

Terms defined by reference

References

Normative References

[CSS-BOX-3]
Elika Etemad. CSS Box Model Module Level 3. 9 August 2018. WD. URL: https://www.w3.org/TR/css-box-3/
[CSS-BREAK-3]
Rossen Atanassov; Elika Etemad. CSS Fragmentation Module Level 3. 9 February 2017. CR. URL: https://www.w3.org/TR/css-break-3/
[CSS-CASCADE-4]
Elika Etemad; Tab Atkins Jr.. CSS Cascading and Inheritance Level 4. 14 January 2016. CR. URL: https://www.w3.org/TR/css-cascade-4/
[CSS-FLEXBOX-1]
Tab Atkins Jr.; Elika Etemad; Rossen Atanassov. CSS Flexible Box Layout Module Level 1. 19 October 2017. CR. URL: https://www.w3.org/TR/css-flexbox-1/
[CSS-GRID-1]
Tab Atkins Jr.; Elika Etemad; Rossen Atanassov. CSS Grid Layout Module Level 1. 14 December 2017. CR. URL: https://www.w3.org/TR/css-grid-1/
[CSS-INLINE-3]
Dave Cramer; Elika Etemad; Steve Zilles. CSS Inline Layout Module Level 3. 8 August 2018. WD. URL: https://www.w3.org/TR/css-inline-3/
[CSS-OVERFLOW-3]
David Baron; Elika Etemad; Florian Rivoal. CSS Overflow Module Level 3. 31 July 2018. WD. URL: https://www.w3.org/TR/css-overflow-3/
[CSS-PAGE-FLOATS-3]
Johannes Wilm. CSS Page Floats. 15 September 2015. WD. URL: https://www.w3.org/TR/css-page-floats-3/
[CSS-POSITION-3]
Rossen Atanassov; Arron Eicholz. CSS Positioned Layout Module Level 3. 17 May 2016. WD. URL: https://www.w3.org/TR/css-position-3/
[CSS-PSEUDO-4]
Daniel Glazman; Elika Etemad; Alan Stearns. CSS Pseudo-Elements Module Level 4. 7 June 2016. WD. URL: https://www.w3.org/TR/css-pseudo-4/
[CSS-SIZING-3]
Tab Atkins Jr.; Elika Etemad. CSS Intrinsic & Extrinsic Sizing Module Level 3. 4 March 2018. WD. URL: https://www.w3.org/TR/css-sizing-3/
[CSS-TYPED-OM-1]
Shane Stephens; Tab Atkins Jr.; Naina Raisinghani. CSS Typed OM Level 1. 10 April 2018. WD. URL: https://www.w3.org/TR/css-typed-om-1/
[CSS-VALUES-4]
Tab Atkins Jr.; Elika Etemad. CSS Values and Units Module Level 4. 14 August 2018. WD. URL: https://www.w3.org/TR/css-values-4/
[CSS-WRITING-MODES-4]
Elika Etemad; Koji Ishii. CSS Writing Modes Level 4. 24 May 2018. CR. URL: https://www.w3.org/TR/css-writing-modes-4/
[CSS21]
Bert Bos; et al. Cascading Style Sheets Level 2 Revision 1 (CSS 2.1) Specification. 7 June 2011. REC. URL: https://www.w3.org/TR/CSS2/
[CSS3-DISPLAY]
Tab Atkins Jr.; Elika Etemad. CSS Display Module Level 3. 9 August 2018. WD. URL: https://www.w3.org/TR/css-display-3/
[CSSOM-1]
Simon Pieters; Glenn Adams. CSS Object Model (CSSOM). 17 March 2016. WD. URL: https://www.w3.org/TR/cssom-1/
[DOM]
Anne van Kesteren. DOM Standard. Living Standard. URL: https://dom.spec.whatwg.org/
[HTML]
Anne van Kesteren; et al. HTML Standard. Living Standard. URL: https://html.spec.whatwg.org/multipage/
[INFRA]
Anne van Kesteren; Domenic Denicola. Infra Standard. Living Standard. URL: https://infra.spec.whatwg.org/
[RFC2119]
S. Bradner. Key words for use in RFCs to Indicate Requirement Levels. March 1997. Best Current Practice. URL: https://tools.ietf.org/html/rfc2119
[WebIDL]
Cameron McCormack; Boris Zbarsky; Tobie Langel. Web IDL. 15 December 2016. ED. URL: https://heycam.github.io/webidl/
[WORKLETS-1]
Ian Kilpatrick. Worklets Level 1. 7 June 2016. WD. URL: https://www.w3.org/TR/worklets-1/

Informative References

[CSS-BACKGROUNDS-3]
Bert Bos; Elika Etemad; Brad Kemper. CSS Backgrounds and Borders Module Level 3. 17 October 2017. CR. URL: https://www.w3.org/TR/css-backgrounds-3/
[CSS-MULTICOL-1]
Florian Rivoal; Rachel Andrew. CSS Multi-column Layout Module Level 1. 28 May 2018. WD. URL: https://www.w3.org/TR/css-multicol-1/

IDL Index

[Exposed=LayoutWorklet]
interface LayoutChild {
    readonly attribute StylePropertyMapReadOnly styleMap;

    IntrinsicSizesRequest intrinsicSizes();
    LayoutFragmentRequest layoutNextFragment(LayoutConstraints constraints, ChildBreakToken breakToken);
};

[Exposed=LayoutWorklet]
interface LayoutFragment {
    readonly attribute double inlineSize;
    readonly attribute double blockSize;

    attribute double inlineOffset;
    attribute double blockOffset;

    readonly attribute any data;

    readonly attribute ChildBreakToken? breakToken;
};

[Exposed=LayoutWorklet]
interface IntrinsicSizes {
  readonly attribute double minContentSize;
  readonly attribute double maxContentSize;
};

[Constructor(optional LayoutConstraintsOptions options),Exposed=LayoutWorklet]
interface LayoutConstraints {
    readonly attribute double availableInlineSize;
    readonly attribute double availableBlockSize;

    readonly attribute double? fixedInlineSize;
    readonly attribute double? fixedBlockSize;

    readonly attribute double percentageInlineSize;
    readonly attribute double percentageBlockSize;

    readonly attribute double? blockFragmentationOffset;
    readonly attribute BlockFragmentationType blockFragmentationType;

    readonly attribute any data;
};

dictionary LayoutConstraintsOptions {
    double availableInlineSize = 0;
    double availableBlockSize = 0;

    double fixedInlineSize;
    double fixedBlockSize;

    double percentageInlineSize;
    double percentageBlockSize;

    double blockFragmentationOffset;
    BlockFragmentationType blockFragmentationType = "none";

    any data;
};

enum BlockFragmentationType { "none", "page", "column", "region" };

[Exposed=LayoutWorklet]
interface ChildBreakToken {
    readonly attribute BreakType breakType;
    readonly attribute LayoutChild child;
};

[Exposed=LayoutWorklet]
interface BreakToken {
    readonly attribute FrozenArray<ChildBreakToken> childBreakTokens;
    readonly attribute any data;
};

dictionary BreakTokenOptions {
    sequence<ChildBreakToken> childBreakTokens;
    any data = null;
};

enum BreakType { "none", "line", "column", "page", "region" };

[Exposed=LayoutWorklet]
interface LayoutEdgeSizes {
  readonly attribute double inlineStart;
  readonly attribute double inlineEnd;

  readonly attribute double blockStart;
  readonly attribute double blockEnd;

  // Convenience attributes for the sum in one direction.
  readonly attribute double inline;
  readonly attribute double block;
};

[Exposed=LayoutWorklet]
interface LayoutEdges {
  readonly attribute LayoutEdgeSizes border;
  readonly attribute LayoutEdgeSizes scrollbar;
  readonly attribute LayoutEdgeSizes padding;

  readonly attribute LayoutEdgeSizes all;
};

partial namespace CSS {
    [SameObject] readonly attribute Worklet layoutWorklet;
};

[Global=(Worklet,LayoutWorklet),Exposed=LayoutWorklet]
interface LayoutWorkletGlobalScope : WorkletGlobalScope {
    void registerLayout(DOMString name, VoidFunction layoutCtor);
};

[Exposed=LayoutWorklet]
dictionary LayoutOptions {
  ChildDisplayType childDisplay = "block";
  LayoutSizingMode sizing = "block-like";
};

[Exposed=LayoutWorklet]
enum ChildDisplayType {
    "block",
    "normal",
};

[Exposed=LayoutWorklet]
enum LayoutSizingMode {
    "block-like",
    "manual",
};

[Exposed=LayoutWorklet]
interface IntrinsicSizesRequest {
};

[Exposed=LayoutWorklet]
interface LayoutFragmentRequest {
};

typedef (IntrinsicSizesRequest or LayoutFragmentRequest)
    LayoutFragmentRequestOrIntrinsicSizesRequest;

// This is the final return value from the author defined layout() method.
dictionary FragmentResultOptions {
    double inlineSize = 0;
    double blockSize = 0;
    double autoBlockSize = 0;
    sequence<LayoutFragment> childFragments = [];
    any data = null;
    BreakTokenOptions breakToken = null;
};

dictionary IntrinsicSizesResultOptions {
    double maxContentSize;
    double minContentSize;
};

Issues Index

Issue: Currently the API is in an iterable generator form. Based on implementation experience, and web developer experience, this may change to promise based API instead. There are both pros and cons to each of these.

Promises

Generator

We may want to store styleMap on box instead, similar to layoutInstance.
We may want to store styleMap on box instead, similar to layoutInstance.