Class StoryBookPage
A StoryBookPage is a page that can be used inside a StoryBook.
Inherited Members
Namespace: Unity.AppUI.Editor
Assembly: Unity.AppUI.Editor.dll
Syntax
public abstract class StoryBookPageFields
m_Stories
The list of stories (used internally).
Declaration
protected readonly List<StoryBookStory> m_StoriesField Value
| Type | Description |
|---|---|
| List<StoryBookStory> |
Properties
componentType
The type of the component.
Declaration
public virtual Type componentType { get; }Property Value
| Type | Description |
|---|---|
| Type |
displayName
The name of the page.
Declaration
public virtual string displayName { get; }Property Value
| Type | Description |
|---|---|
| string |
stories
The stories of the page.
Declaration
public IEnumerable<StoryBookStory> stories { get; }Property Value
| Type | Description |
|---|---|
| IEnumerable<StoryBookStory> |
Methods
AddStory(string, Func<VisualElement>)
Add a story to the page with a name and a function that creates the GUI of the story.
Declaration
protected void AddStory(string name, Func<VisualElement> createGUI)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name of the story. |
| Func<VisualElement> | createGUI | The function that creates the GUI of the story. |
AddStory(StoryBookStory)
Add a story to the page.
Declaration
protected void AddStory(StoryBookStory story)Parameters
| Type | Name | Description |
|---|---|---|
| StoryBookStory | story | The story to add. |