H3lp Yours3lfDocs
api

list

Build a vertical list from items or child layouts.

Builds a vertical ui.TYPE.Flex. Use items for a list of layouts, or children or content when the source is already named that way.

Example

local ui = require 'openmw.ui'
local list = require 'scripts.s3.components.list'
local listItem = require 'scripts.s3.components.listItem'

ui.create {
  type = ui.TYPE.Container,
  layer = 'Windows',
  content = ui.content {
    list {
      items = {
        listItem {
          label = 'First entry',
        },
        listItem {
          label = 'Second entry',
        },
      },
    },
  },
}

Parameters

FieldTypeDescription
itemstable?Child layouts; used when content and children are absent.
contenttable?Child content; takes precedence over children and items.
childrentable?Child layouts; takes precedence over items.
templateopenmw.ui.Template?Replaces the default list template.

Common layout fields are documented on the UI Components overview.

See also

listItem · grid · column