Skip to content

ListItemCache

Official

The cache of the list item in the note. List items are markdown blocks that are used to create lists.

1. Ordered List Item 1 2. Ordered List Item 2 3. Ordered List Item 3 ```
<ImportStatement text="import type { ListItemCache } from 'obsidian';" />
<TypeSignature kind="interface" name="ListItemCache" extends={["CacheItem"]} />
**Extends:** [CacheItem](/obsidian-typings/public/api/obsidian/augmentations/CacheItem/)
<PropertyTable rows={[
{ status: ApiStatus.Official, name: "id?", href: "./id/", type: "<a href=\"https://www.typescriptlang.org/docs/handbook/basic-types.html#string\">string</a> | <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined\">undefined</a>", description: "The block ID of this list item, if defined." },
{ status: ApiStatus.Official, name: "parent", href: "./parent/", type: "<a href=\"https://www.typescriptlang.org/docs/handbook/basic-types.html#number\">number</a>", description: "Line number of the parent list item (position.start.line). If this item has no parent (e.g. it's a root level list), then this value is the negative of the line number of the first list item (start of the list).<br/><br/>Can be used to deduce which list items belongs to the same group (item1.parent === item2.parent). Can be used to reconstruct hierarchy information (parentItem.position.start.line === childItem.parent)." },
{ status: ApiStatus.Official, name: "position", href: "/obsidian-typings/public/api/obsidian/augmentations/CacheItem/position/", type: "<a href=\"/obsidian-typings/public/api/obsidian/augmentations/Pos/\">Pos</a>", description: "Position of this item in the note.", inheritedFrom: "<a href=\"/obsidian-typings/public/api/obsidian/augmentations/CacheItem/\">CacheItem</a>" },
{ status: ApiStatus.Official, name: "task?", href: "./task/", type: "<a href=\"https://www.typescriptlang.org/docs/handbook/basic-types.html#string\">string</a> | <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined\">undefined</a>", description: "A single character indicating the checked status of a task. The space character <code>' '</code> is interpreted as an incomplete task. Any other character is interpreted as completed task. <code>undefined</code> if this item isn't a task." },
]} />
---
**Links to this page:**
- [BlockSubpathResult](/obsidian-typings/public/api/obsidian/augmentations/BlockSubpathResult/)
- [CachedMetadata](/obsidian-typings/public/api/obsidian/augmentations/CachedMetadata/)