Skip to main content

component-View

View​

type View = {
  id?: string;
  children?: Component[];
  width?: f32;
  height?: f32;
  direction?: "row" | "column";
  top?: f32;
  left?: f32;
  bottom?: f32;
  right?: f32;
  rotation?: f32;
  transition?: Transition;
  overflow?: "visible" | "hidden" | "fit";
  background_color_rgba?: string;
}

Properties​

  • id - Id of a component.
  • children - List of component's children.
  • width - Width of a component in pixels. Exact behavior might be different based on the parent component:
    • If the parent component is a layout, check sections "Absolute positioning" and "Static positioning" of that component.
    • If the parent component is not a layout, then this field is required.
  • height - Height of a component in pixels. Exact behavior might be different based on the parent component:
    • If the parent component is a layout, check sections "Absolute positioning" and "Static positioning" of that component.
    • If the parent component is not a layout, then this field is required.
  • direction - Direction defines how static children are positioned inside a View component.
    • "row" - Children positioned from left to right.
    • "column" - Children positioned from top to bottom.
  • top - Distance in pixels between this component's top edge and its parent's top edge. If this field is defined, then the component will ignore a layout defined by its parent.
  • left - Distance in pixels between this component's left edge and its parent's left edge. If this field is defined, this element will be absolutely positioned, instead of being laid out by its parent.
  • bottom - Distance in pixels between the bottom edge of this component and the bottom edge of its parent. If this field is defined, this element will be absolutely positioned, instead of being laid out by its parent.
  • right - Distance in pixels between this component's right edge and its parent's right edge. If this field is defined, this element will be absolutely positioned, instead of being laid out by its parent.
  • rotation - Rotation of a component in degrees. If this field is defined, this element will be absolutely positioned, instead of being laid out by its parent.
  • transition - Defines how this component will behave during a scene update. This will only have an effect if the previous scene already contained a View component with the same id.
  • overflow - (default="hidden") Controls what happens to content that is too big to fit into an area.

    • "visible" - Render everything, including content that extends beyond their parent.

    • "hidden" - Render only parts of the children that are inside their parent area.

    • "fit" - If children components are too big to fit inside the parent, resize everything inside to fit.

      Components that have unknown sizes will be treated as if they had a size 0 when calculating scaling factor.

      warning

      This will resize everything inside, even absolutely positioned elements. For example, if you have an element in the bottom right corner and the content will be rescaled by a factor 0.5x, then that component will end up in the middle of its parent

  • background_color_rgba - (default="#00000000") Background color in a "#RRGGBBAA" format.

Transition​

type Transition = {
  duration_ms: f64;
  easing_function?: EasingFunction;
}

Properties​

  • duration_ms - Duration of a transition in milliseconds.
  • easing_function - (default="linear") Easing function to be used for the transition.

EasingFunction​

type EasingFunction = 
  | { function_name: "linear"; }
  | { function_name: "bounce"; }
  | {
      function_name: "cubic_bezier";
      points: [f64, f64, f64, f64];
    }

Easing functions are used to interpolate between two values over time.

Custom easing functions can be implemented with cubic Bézier. The control points are defined with points field by providing four numerical values: x1, y1, x2 and y2. The x1 and x2 values have to be in the range [0; 1]. The cubic Bézier result is clamped to the range [0; 1]. You can find example control point configurations here.