ISlide interface

📖 Description

Describes the interface that holds a slide.

📃 Type declaration

interface ISlide {
  index: number;Readonly
  id: string;Readonly
  section: Section | undefined;Readonly
  context: Context | undefined;Readonly
  label: string;Readonly
  name: string;Readonly
  description: string;Readonly
  bookmark: IBookmark;Readonly
  nodes: IObservableNode[];Readonly
  isFirst: boolean;Readonly
  isLast: boolean;Readonly
  isPassed: boolean;Readonly
  isFailed: boolean;Readonly
  previous: ISlide | undefined;Readonly
  next: ISlide | undefined;Readonly
}

🖱️ Hover with the mouse over a property name for a tooltip with the description of that property. Click it for more information.

🗃️ Properties

---

🏷️ bookmark

Reference to the slide bookmark.

Type

IBookmark

---

🏷️ context

Contains the context for the bookmark.

Type

Context | undefined

---

🏷️ description

Description for the bookmark.

Type

string

---

🏷️ id

Contains the identifier of the bookmark.

Type

string

---

🏷️ index

Contains the zero-basded index number of the slide in the slides array.

Type

number

---

🏷️ isFailed

Contains if the validation of one the nodes in the slide has failed.

Type

boolean

---

🏷️ isFirst

Contains if this is the first slide in the slides array.

Type

boolean

---

🏷️ isLast

Contains if this is the last slide in the slides array.

Type

boolean

---

🏷️ isPassed

Contains if the validation of all nodes in the slide is passed.

Type

boolean

---

🏷️ label

Name for the bookmark (this is the name of the bookmark with any markdown processed).

Type

string

---

🏷️ name

Name for the bookmark.

Type

number

---

🏷️ next

Reference to the next slide in the slides array.

Type

ISlide | undefined

---

🏷️ nodes

Contains the nodes in the bookmark.

Type

IObservableNode[]

---

🏷️ previous

Reference to the previous slide in the slides array.

Type

ISlide | undefined

---

🏷️ section

Reference to the section that defined the bookmark.

Type

Section | undefined