## class: `WyPreview`, `wy-preview`

Preview component.
Consumes WeavyComponent contexts.

**Used sub components:**

*   [`<wy-button>`](./ui/wy-button)
*   [`<wy-dropdown>`](./ui/wy-dropdown)
*   [`<wy-icon>`](./ui/wy-icon)
*   [`<wy-item>`](./ui/wy-item)
*   [`<wy-overlay>`](./ui/wy-overlay)
*   [`<wy-progress-circular>`](./ui/wy-progress-circular)
*   [`<wy-titlebar>`](./ui/wy-titlebar)
*   [`<wy-preview-item>`](./wy-preview-item)
*   [`<wy-file-menu>`](./wy-file-menu)
*   [`<wy-comment-list>`](./wy-comment-list)
*   [`<wy-file-versions>`](./wy-file-versions)

### Fields

| Name           | Type                       | Default | Description                                                         | Inherited From        |
| -------------- | -------------------------- | ------- | ------------------------------------------------------------------- | --------------------- |
| `files`        | `FileType[] \| undefined`  |         | Files available to render inside the preview carousel.              |                       |
| `currentId`    | `number`                   | `NaN`   | Identifier of the file currently displayed in the overlay.          |                       |
| `isAttachment` | `boolean`                  | `false` | Treat provided files as attachments, disabling contextual sidebars. |                       |
| `filled`       | `boolean`                  | `false` | Forces the overlay to use the full-screen layout.                   |                       |
| `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        |
| ----------- | ---------------------------------------------------- | --------------------------------------------------- | ---------------------------- | --------------------- |
| `open`      | Opens the overlay for the provided file identifier.  | `fileId: number, showTab: "comments" \| "versions"` |                              |                       |
| `close`     | Closes the preview overlay.                          |                                                     |                              |                       |
| `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-preview-open`  | `WyPreviewOpenEventType`  | Fired when a preview overlay is about to open.    |                   |
| `wy-preview-close` | `WyPreviewCloseEventType` | Fired when a preview overlay is closed.           |                   |
| `wy-action`        | `WyActionEventType`       | Emitted when an embed action button is triggered. |                   |
| `ready`            | `CustomEvent`             | When the component has rendered.                  | WeavySubComponent |

### Attributes

| Name           | Field        | Inherited From |
| -------------- | ------------ | -------------- |
| `currentId`    | currentId    |                |
| `isAttachment` | isAttachment |                |
| `filled`       | filled       |                |

### CSS Parts

| Name                | Description                                  |
| ------------------- | -------------------------------------------- |
| `wy-dark`           | Overlay dark/root modifier.                  |
| `wy-preview-layout` | Layout wrapper for the preview.              |
| `wy-preview-main`   | Main preview content area.                   |
| `wy-sidebar`        | Sidebar container for comments/versions.     |
| `wy-pane`           | Pane wrapper inside sidebars.                |
| `wy-preview`        | Preview container for content.               |
| `wy-preview-swiper` | Swiper container for multiple preview panes. |
| `wy-preview-area`   | Individual preview area for a single file.   |
| `wy-nav-prev`       | Previous navigation control.                 |
| `wy-nav-next`       | Next navigation control.                     |

<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`                        | `WyPreview`  | WyPreview   | lib/components/wy-preview\.ts |         |
| `custom-element-definition` | `wy-preview` | WyPreview   | lib/components/wy-preview\.ts |         |
