## class: `WyPostList`, `wy-post-list`

List container rendering a paginated list of posts.

**Used sub components:**

*   [`<wy-post>`](./wy-post)
*   [`<wy-empty>`](./wy-empty)
*   [`<wy-progress-circular>`](./ui/wy-progress-circular)

### Fields

| Name     | Type                       | Default                                                                                      | Description                                                     | Inherited From        |
| -------- | -------------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | --------------------- |
| `unread` | `number`                   |                                                                                              | Current unread conversation count.                              |                       |
| `feed`   | `boolean`                  | `false`                                                                                      | Whether the post list a feed of posts.                          |                       |
| `filter` | `PostQueryFilterType`      | `{ app: undefined, q: "", tag: "", trashed: false, following: false, order_by: undefined, }` | Which posts to show.                                            |                       |
| `app`    | `AppType \| undefined`     |                                                                                              | The app data.                                                   | WeavySubAppComponent  |
| `apps`   | `AppListType \| undefined` |                                                                                              | Multiple apps data.                                             | WeavySubAppComponent  |
| `link`   | `LinkType \| undefined`    |                                                                                              | Any provided link that should be loaded, shown and highlighted. | WeavySubTypeComponent |

### Methods

| Name        | Description                                          | Parameters | Return                       | Inherited From        |
| ----------- | ---------------------------------------------------- | ---------- | ---------------------------- | --------------------- |
| `whenApp`   | Resolves when app data is available.                 |            | `Promise<AppType>`           | WeavySubAppComponent  |
| `whenApps`  | Resolves when multiple app data is available.        |            | `Promise<AppListType>`       | WeavySubAppComponent  |
| `whenLink`  | Resolves when a provided link is available.          |            | `Promise<LinkType>`          | WeavySubTypeComponent |
| `whenReady` | Resolves when the component has rendered first time. |            | `Promise<WeavySubComponent>` | WeavySubComponent     |

### Events

| Name               | Type                      | Description                                       | Inherited From    |
| ------------------ | ------------------------- | ------------------------------------------------- | ----------------- |
| `wy-action`        | `WyActionEventType`       | Emitted when an embed action button is triggered. |                   |
| `wy-preview-open`  | `WyPreviewOpenEventType`  | Fired when a preview overlay is about to open.    |                   |
| `wy-preview-close` | `WyPreviewCloseEventType` | Fired when a preview overlay is closed.           |                   |
| `ready`            | `CustomEvent`             | When the component has rendered.                  | WeavySubComponent |

### Attributes

| Name     | Field  | Inherited From |
| -------- | ------ | -------------- |
| `feed`   | feed   |                |
| `filter` | filter |                |

### CSS Parts

| Name              | Description                          |
| ----------------- | ------------------------------------ |
| `wy-post`         | Wrapper for each post/editor block.  |
| `wy-pager`        | Pager container.                     |
| `wy-pager-bottom` | Pager modifier for bottom placement. |

<details><summary>Private API</summary>

### Fields

| Name                        | Privacy | Type                                                               | Default                                                                               | Description | Inherited From        |
| --------------------------- | ------- | ------------------------------------------------------------------ | ------------------------------------------------------------------------------------- | ----------- | --------------------- |
| `#resolveApp`               | private | `(app: AppType) => void \| undefined`                              |                                                                                       |             | WeavySubAppComponent  |
| `#whenApp`                  | private |                                                                    | `new Promise<AppType>((r) => { this.#resolveApp = r; })`                              |             | WeavySubAppComponent  |
| `#resolveApps`              | private | `(apps: AppListType) => void \| undefined`                         |                                                                                       |             | WeavySubAppComponent  |
| `#whenApps`                 | private |                                                                    | `new Promise<AppListType>((r) => { this.#resolveApps = r; })`                         |             | WeavySubAppComponent  |
| `#resolveContextDataBlobs`  | private | `(blobs: ContextDataBlobsType) => void \| undefined`               |                                                                                       |             | WeavySubTypeComponent |
| `#whenContextDataBlobs`     | private |                                                                    | `new Promise<ContextDataBlobsType>((r) => { this.#resolveContextDataBlobs = r; })`    |             | WeavySubTypeComponent |
| `#resolveComponentFeatures` | private | `(componentFeatures: ComponentFeaturePolicy) => void \| undefined` |                                                                                       |             | WeavySubTypeComponent |
| `#whenComponentFeatures`    | private |                                                                    | `new Promise<ComponentFeaturePolicy>((r) => { this.#resolveComponentFeatures = r; })` |             | WeavySubTypeComponent |
| `#resolveLink`              | private | `(link: LinkType) => void \| undefined`                            |                                                                                       |             | WeavySubTypeComponent |
| `#whenLink`                 | private |                                                                    | `new Promise<LinkType>((r) => { this.#resolveLink = r; })`                            |             | WeavySubTypeComponent |
| `#resolveSettings`          | private | `(settings: WeavyComponentSettingsType) => void \| undefined`      |                                                                                       |             | WeavySubTypeComponent |
| `#whenSettings`             | private |                                                                    | `new Promise<WeavyComponentSettingsType>((r) => { this.#resolveSettings = r; })`      |             | WeavySubTypeComponent |
| `#resolveContextId`         | private | `(contextId: ContextIdType) => void \| undefined`                  |                                                                                       |             | WeavySubComponent     |
| `#whenContextId`            | private |                                                                    | `new Promise<ContextIdType>((r) => { this.#resolveContextId = r; })`                  |             | WeavySubComponent     |
| `#resolveUser`              | private | `(user: UserType) => void \| undefined`                            |                                                                                       |             | WeavySubComponent     |
| `#whenUser`                 | private |                                                                    | `new Promise<UserType>((r) => { this.#resolveUser = r; })`                            |             | WeavySubComponent     |
| `#resolveWeavy`             | private | `(weavy: WeavyType) => void \| undefined`                          |                                                                                       |             | WeavySubComponent     |
| `#whenWeavy`                | private |                                                                    | `new Promise<WeavyType>((r) => { this.#resolveWeavy = r; })`                          |             | WeavySubComponent     |
| `#resolveReady`             | private | `(component: WeavySubComponent) => void \| undefined`              |                                                                                       |             | WeavySubComponent     |
| `#whenReady`                | private |                                                                    | `new Promise<WeavySubComponent>((r) => { this.#resolveReady = r; })`                  |             | WeavySubComponent     |

</details>

<hr/>

## Exports

| Kind                        | Name           | Declaration | Module                         | Package |
| --------------------------- | -------------- | ----------- | ------------------------------ | ------- |
| `js`                        | `WyPostList`   | WyPostList  | lib/components/wy-post-list.ts |         |
| `custom-element-definition` | `wy-post-list` | WyPostList  | lib/components/wy-post-list.ts |         |
