package designcompose.definition.view

Get desktop application:
View/edit binary Protocol Buffers messages

Details on the Figma component that this view is an instance of.

Used in: View

• string id = 1

• string name = 2

• string component_set_name = 3

• optional ComponentOverrides overrides = 4

  Previously we only figure out overrides for the root of a component This is now deprecated and will be removed soon.

• map<string, ComponentOverrides> overrides_table = 5

  Descendent view name -> ComponentOverrides mappings. This works only if view name is identical. For the component root view, it uses the component_set_name as the key because the component name differs per variant.

Figma component properties can be "overridden" in the UI. These overrides are applied in the node tree we get back from Figma, so we don't have to worry about them, unless we present a variant of a component as a result of an interaction. In that case, we need to figure out what has been overridden and apply it to the variant. This struct keeps track of those overrides that need to be applied to variant instances.

Used in: ComponentInfo

• optional ViewStyle style = 1

• optional ViewData view_data = 5

Configures whether a view is displayed using a Flexbox layout or not at all.

Used in: NodeStyle

• DISPLAY_UNSPECIFIED = 0

• DISPLAY_FLEX = 1

• DISPLAY_NONE = 2

Contains all of the styleable parameters accepted by the Rect and Text components. Next id = 45

Used in: ViewStyle

• optional element.Background text_color = 1

  Text properties

• optional element.NumOrVar font_size = 2

• optional string font_family = 3

• optional element.FontWeight font_weight = 4

• element.FontStyle font_style = 5

• element.TextDecoration text_decoration = 40

• optional float letter_spacing = 41

• optional element.FontStretch font_stretch = 6

• repeated element.Background backgrounds = 7

• repeated modifier.BoxShadow box_shadows = 8

• optional element.Stroke stroke = 9

• optional float opacity = 10

• optional modifier.LayoutTransform transform = 11

  Transforms

• optional modifier.LayoutTransform relative_transform = 12

• modifier.TextAlign text_align = 13

  Text layout

• modifier.TextAlignVertical text_align_vertical = 14

• modifier.TextOverflow text_overflow = 15

• optional modifier.TextShadow text_shadow = 16

• optional element.Size node_size = 17

  Size and layout

• optional element.LineHeight line_height = 18

• optional int32 line_count = 19

• repeated element.FontFeature font_features = 20

• repeated modifier.FilterOp filters = 21

• repeated modifier.FilterOp backdrop_filters = 22

• modifier.BlendMode blend_mode = 23

• Display display_type = 24

  Layout properties

• layout.FlexWrap flex_wrap = 25

• optional layout.GridLayoutType grid_layout_type = 26

• uint32 grid_columns_rows = 27

• uint32 grid_adaptive_min_size = 28

• repeated layout.GridSpan grid_span_contents = 29

• layout.Overflow overflow = 30

• optional uint32 max_children = 31

• optional string overflow_node_id = 32

• optional string overflow_node_name = 33

• float cross_axis_item_spacing = 34

• layout.LayoutSizing horizontal_sizing = 35

• layout.LayoutSizing vertical_sizing = 36

• optional float aspect_ratio = 37

• interaction.PointerEvents pointer_events = 38

• optional plugin.MeterData meter_data = 39

• optional element.Hyperlink hyperlink = 42

• optional element.ShaderData shader_data = 43

  Runtime shader from the shader plugin as background. When shader is present, background will not be drawn.

• optional element.ScalableUIData scalable_data = 44

A section of text with a specific style

Used in: ViewData.StyledTextRuns

• string text = 1

• optional TextStyle style = 2

These are the style properties that apply to text, so we can use them on subsections of a longer string. We then assume that every style transition is a potential line break (and also run the linebreaking algorithm on the content of every style for the normal case where we need to break text that's all in one style).

Used in: StyledTextRun

• optional element.Background text_color = 1

• optional element.NumOrVar font_size = 2

• optional string font_family = 3

• optional element.FontWeight font_weight = 4

• element.FontStyle font_style = 5

• optional element.FontStretch font_stretch = 6

• float letter_spacing = 7

• element.TextDecoration text_decoration = 8

• optional element.LineHeight line_height = 9

• repeated element.FontFeature font_features = 10

• optional element.Hyperlink hyperlink = 11

Represents a toolkit View (like a Composable).

Used in: DesignComposeDefinition, ViewData.Container

• uint32 unique_id = 1

  unique numeric id (not replicated within one DesignCompose file), which is used by the renderer when building a layout tree, or when mapping from an integer to a View. IMPORTANT: This is a u16, but proto doesn't do short types. Convert back to u16 after deserializing

• string id = 2

  id doesn't exist in vsw toolkit, but is useful for tracing from Figma node to output

• string name = 3

  name doesn't exist in vsw toolkit, but is also useful for tracing.

• optional ComponentInfo component_info = 4

  information on the component that this view is an instance of (if any).

• repeated interaction.Reaction reactions = 5

  interactivity

• optional plugin.FrameExtras frame_extras = 6

  interactivity related frame properties

• optional layout.ScrollInfo scroll_info = 7

  overflow (scrolling) data

• optional ViewStyle style = 8

  common style

• optional ViewData data = 9

  details that are unique to each view type.

• optional element.Rectangle design_absolute_bounding_box = 10

  absolute bounding box of the view in the design document

• View.RenderMethod render_method = 11

  hint for the renderer on how to render the view

• map<string, string> explicit_variable_modes = 12

  a hash of variable collection id -> mode id if variable modes are set on this view

This enum may be used as a hint by the DesignCompose renderer implementation to determine if it is important for the content to be rendered identically on different platforms.

Used in: View

• RENDER_METHOD_UNSPECIFIED = 0

• RENDER_METHOD_NONE = 1

• RENDER_METHOD_PIXEL_PERFECT = 2

Details that are unique to each view type.

Used in: ComponentOverrides, View

• oneof view_data_type

  • ViewData.Container container = 1

  • ViewData.Text text = 2

  • ViewData.StyledTextRuns styled_text = 3

Container is used to represent views that act as containers for other views, like a Column or a Row in Jetpack Compose. The shape field defines the visual appearance of the container, while the children field defines the views that are contained within it.

Used in: ViewData

• optional element.ViewShape shape = 1

• repeated View children = 2

A collection of styled text sections

Used in: ViewData

• repeated StyledTextRun styled_texts = 1

• optional string res_name = 2

A Text view with a possible resource name attached to it

Used in: ViewData

• string content = 1

• optional string res_name = 2

Collects the Layout and Node styles for a View

Used in: ComponentOverrides, View

• optional layout.LayoutStyle layout_style = 1

• optional NodeStyle node_style = 2