Skip to content

ui_hints

Required: No
Type: Map of UI hints
Condition: No

Hints to GUI tooling to assist in rendering the component.

Key Required Type Description
highlight No String Path to file that should be highlighted by IDEs in an appropriate way (opened by default, printed to console, etc). May refer to any file in the project, including files in the autogen and config directories. If set, the file referenced by this entry has focus.
List of paths List of maps, each referencing a file to be highlighted by IDEs. The key path contains the path to the file, while focus is a boolean indicating if this file should have editor focus. The key condition takes a list of features, and the file is highlighted if all the given features are present in the resolved project, while unless takes a list of features that exclude the file from highlighting if any of the given features are present. After resolving conditions, only one file may have focus set to true.

In addition to files listed in highlight, the .slcp file is always considered highlighted. If no other entry has focus, the .slcp file has focus.

1
2
3
4
5
6
7
ui_hints:
  highlight:
    - path: main.c
    - path: README.md
      focus: true
      condition: [foo]
      unless: [bar]
Back to top