Source code for atlas_doc_parser.marks.mark_breakout

# -*- coding: utf-8 -*-

import typing as T
import dataclasses

from func_args.api import REQ, OPT

from ..type_enum import TypeEnum
from ..mark_or_node import Base, BaseMark



[docs]
@dataclasses.dataclass(frozen=True)
class MarkBreakoutAttrs(Base):
    """
    Attributes for :class:`MarkBreakout`.

    :param mode: Required. Breakout mode. Valid values are ``"wide"`` or ``"full-width"``.
    :param width: Optional. Width value.
    """

    mode: T.Literal["wide", "full-width"]
    width: int = OPT




[docs]
@dataclasses.dataclass(frozen=True)
class MarkBreakout(BaseMark):
    """
    Breakout mark for layout width control.

    This mark controls the layout breakout mode of elements, allowing them
    to extend beyond the normal content width.
    """

    type: str = TypeEnum.breakout.value
    attrs: MarkBreakoutAttrs = REQ