feat(editor): embed iframe error status card in surface (#10869)

To close [BS-2806](https://linear.app/affine-design/issue/BS-2806/iframe-embed-block-edgeless-loading-and-error-status)
This commit is contained in:
donteatfriedrice
2025-03-16 09:05:04 +00:00
parent 7ecb1f510d
commit d7d512084e
4 changed files with 86 additions and 39 deletions

View File

@@ -1,7 +1,6 @@
import { createLitPortal } from '@blocksuite/affine-components/portal'; import { createLitPortal } from '@blocksuite/affine-components/portal';
import type { EmbedIframeBlockModel } from '@blocksuite/affine-model'; import type { EmbedIframeBlockModel } from '@blocksuite/affine-model';
import { unsafeCSSVarV2 } from '@blocksuite/affine-shared/theme'; import { unsafeCSSVarV2 } from '@blocksuite/affine-shared/theme';
import { stopPropagation } from '@blocksuite/affine-shared/utils';
import type { BlockStdScope } from '@blocksuite/block-std'; import type { BlockStdScope } from '@blocksuite/block-std';
import { WithDisposable } from '@blocksuite/global/lit'; import { WithDisposable } from '@blocksuite/global/lit';
import { EditIcon, InformationIcon, ResetIcon } from '@blocksuite/icons/lit'; import { EditIcon, InformationIcon, ResetIcon } from '@blocksuite/icons/lit';
@@ -9,24 +8,27 @@ import { flip, offset } from '@floating-ui/dom';
import { baseTheme } from '@toeverything/theme'; import { baseTheme } from '@toeverything/theme';
import { css, html, LitElement, unsafeCSS } from 'lit'; import { css, html, LitElement, unsafeCSS } from 'lit';
import { property, query } from 'lit/decorators.js'; import { property, query } from 'lit/decorators.js';
import { classMap } from 'lit/directives/class-map.js';
import { styleMap } from 'lit/directives/style-map.js';
import type { EmbedIframeStatusCardOptions } from '../types';
const LINK_EDIT_POPUP_OFFSET = 12; const LINK_EDIT_POPUP_OFFSET = 12;
const ERROR_CARD_DEFAULT_HEIGHT = 114;
export class EmbedIframeErrorCard extends WithDisposable(LitElement) { export class EmbedIframeErrorCard extends WithDisposable(LitElement) {
static override styles = css` static override styles = css`
:host { :host {
width: 100%; width: 100%;
height: 100%;
} }
.affine-embed-iframe-error-card { .affine-embed-iframe-error-card {
container: affine-embed-iframe-error-card / inline-size; container: affine-embed-iframe-error-card / inline-size;
display: flex; display: flex;
box-sizing: border-box; box-sizing: border-box;
width: 100%;
user-select: none; user-select: none;
height: 114px;
padding: 12px; padding: 12px;
align-items: flex-start;
gap: 12px; gap: 12px;
overflow: hidden; overflow: hidden;
border-radius: 8px; border-radius: 8px;
@@ -38,7 +40,6 @@ export class EmbedIframeErrorCard extends WithDisposable(LitElement) {
.error-content { .error-content {
display: flex; display: flex;
flex-direction: column; flex-direction: column;
align-items: flex-start;
gap: 4px; gap: 4px;
flex: 1 0 0; flex: 1 0 0;
@@ -68,8 +69,6 @@ export class EmbedIframeErrorCard extends WithDisposable(LitElement) {
.error-message { .error-message {
display: flex; display: flex;
height: 40px;
align-items: flex-start;
align-self: stretch; align-self: stretch;
color: ${unsafeCSSVarV2('text/secondary')}; color: ${unsafeCSSVarV2('text/secondary')};
overflow: hidden; overflow: hidden;
@@ -121,17 +120,42 @@ export class EmbedIframeErrorCard extends WithDisposable(LitElement) {
} }
} }
.error-banner {
width: 204px;
height: 102px;
}
@container affine-embed-iframe-error-card (width < 480px) { @container affine-embed-iframe-error-card (width < 480px) {
.error-banner { .error-banner {
display: none; display: none;
} }
} }
} }
.affine-embed-iframe-error-card.horizontal {
flex-direction: row;
align-items: flex-start;
.error-content {
align-items: flex-start;
.error-message {
height: 40px;
align-items: flex-start;
}
}
}
.affine-embed-iframe-error-card.vertical {
flex-direction: column-reverse;
align-items: center;
justify-content: center;
.error-content {
justify-content: center;
align-items: center;
.error-message {
justify-content: center;
align-items: center;
}
}
}
`; `;
private _editAbortController: AbortController | null = null; private _editAbortController: AbortController | null = null;
@@ -168,14 +192,28 @@ export class EmbedIframeErrorCard extends WithDisposable(LitElement) {
}); });
}; };
override connectedCallback() { private readonly _handleRetry = (e: MouseEvent) => {
super.connectedCallback(); e.stopPropagation();
this.disposables.addFromEvent(this, 'click', stopPropagation); this.onRetry();
} };
override render() { override render() {
const { layout, width, height } = this.options;
const cardClasses = classMap({
'affine-embed-iframe-error-card': true,
horizontal: layout === 'horizontal',
vertical: layout === 'vertical',
});
const cardWidth = width ? `${width}px` : '100%';
const cardHeight = height ? `${height}px` : '100%';
const cardStyle = styleMap({
width: cardWidth,
height: cardHeight,
});
return html` return html`
<div class="affine-embed-iframe-error-card"> <div class=${cardClasses} style=${cardStyle}>
<div class="error-content"> <div class="error-content">
<div class="error-title"> <div class="error-title">
<div class="error-icon"> <div class="error-icon">
@@ -193,7 +231,7 @@ export class EmbedIframeErrorCard extends WithDisposable(LitElement) {
> >
<span class="text">Edit</span> <span class="text">Edit</span>
</div> </div>
<div class="button retry" @click=${this.onRetry}> <div class="button retry" @click=${this._handleRetry}>
<span class="icon" <span class="icon"
>${ResetIcon({ width: '16px', height: '16px' })}</span >${ResetIcon({ width: '16px', height: '16px' })}</span
> >
@@ -227,4 +265,10 @@ export class EmbedIframeErrorCard extends WithDisposable(LitElement) {
@property({ attribute: false }) @property({ attribute: false })
accessor std!: BlockStdScope; accessor std!: BlockStdScope;
@property({ attribute: false })
accessor options: EmbedIframeStatusCardOptions = {
layout: 'horizontal',
height: ERROR_CARD_DEFAULT_HEIGHT,
};
} }

View File

@@ -8,23 +8,9 @@ import { classMap } from 'lit/directives/class-map.js';
import { styleMap } from 'lit/directives/style-map.js'; import { styleMap } from 'lit/directives/style-map.js';
import { getEmbedCardIcons } from '../../common/utils'; import { getEmbedCardIcons } from '../../common/utils';
import type { EmbedIframeStatusCardOptions } from '../types';
/** const LOADING_CARD_DEFAULT_HEIGHT = 114;
* The options for the embed iframe loading card
* layout: the layout of the card, horizontal or vertical
* width: the width of the card, if not set, the card width will be 100%
* height: the height of the card, if not set, the card height will be 100%
* @example
* {
* layout: 'horizontal',
* height: 114,
* }
*/
export type EmbedIframeLoadingCardOptions = {
layout: 'horizontal' | 'vertical';
width?: number;
height?: number;
};
export class EmbedIframeLoadingCard extends LitElement { export class EmbedIframeLoadingCard extends LitElement {
static override styles = css` static override styles = css`
@@ -199,8 +185,8 @@ export class EmbedIframeLoadingCard extends LitElement {
accessor std!: BlockStdScope; accessor std!: BlockStdScope;
@property({ attribute: false }) @property({ attribute: false })
accessor options: EmbedIframeLoadingCardOptions = { accessor options: EmbedIframeStatusCardOptions = {
layout: 'horizontal', layout: 'horizontal',
height: 114, height: LOADING_CARD_DEFAULT_HEIGHT,
}; };
} }

View File

@@ -16,10 +16,10 @@ import { html, nothing } from 'lit';
import { type ClassInfo, classMap } from 'lit/directives/class-map.js'; import { type ClassInfo, classMap } from 'lit/directives/class-map.js';
import { ifDefined } from 'lit/directives/if-defined.js'; import { ifDefined } from 'lit/directives/if-defined.js';
import type { EmbedIframeLoadingCardOptions } from './components/embed-iframe-loading-card.js';
import type { IframeOptions } from './extension/embed-iframe-config.js'; import type { IframeOptions } from './extension/embed-iframe-config.js';
import { EmbedIframeService } from './extension/embed-iframe-service.js'; import { EmbedIframeService } from './extension/embed-iframe-service.js';
import { embedIframeBlockStyles } from './style.js'; import { embedIframeBlockStyles } from './style.js';
import type { EmbedIframeStatusCardOptions } from './types.js';
export type EmbedIframeStatus = 'idle' | 'loading' | 'success' | 'error'; export type EmbedIframeStatus = 'idle' | 'loading' | 'success' | 'error';
const DEFAULT_IFRAME_HEIGHT = 152; const DEFAULT_IFRAME_HEIGHT = 152;
@@ -75,7 +75,7 @@ export class EmbedIframeBlockComponent extends CaptionedBlockComponent<EmbedIfra
return flag ?? false; return flag ?? false;
} }
get _loadingCardOptions(): EmbedIframeLoadingCardOptions { get _statusCardOptions(): EmbedIframeStatusCardOptions {
return this.inSurface return this.inSurface
? { layout: 'vertical' } ? { layout: 'vertical' }
: { layout: 'horizontal', height: 114 }; : { layout: 'horizontal', height: 114 };
@@ -213,7 +213,7 @@ export class EmbedIframeBlockComponent extends CaptionedBlockComponent<EmbedIfra
if (this.isLoading$.value) { if (this.isLoading$.value) {
return html`<embed-iframe-loading-card return html`<embed-iframe-loading-card
.std=${this.std} .std=${this.std}
.options=${this._loadingCardOptions} .options=${this._statusCardOptions}
></embed-iframe-loading-card>`; ></embed-iframe-loading-card>`;
} }
@@ -223,6 +223,7 @@ export class EmbedIframeBlockComponent extends CaptionedBlockComponent<EmbedIfra
.model=${this.model} .model=${this.model}
.onRetry=${this._handleRetry} .onRetry=${this._handleRetry}
.std=${this.std} .std=${this.std}
.options=${this._statusCardOptions}
></embed-iframe-error-card>`; ></embed-iframe-error-card>`;
} }

View File

@@ -0,0 +1,16 @@
/**
* The options for the embed iframe status card
* layout: the layout of the card, horizontal or vertical
* width: the width of the card, if not set, the card width will be 100%
* height: the height of the card, if not set, the card height will be 100%
* @example
* {
* layout: 'horizontal',
* height: 114,
* }
*/
export type EmbedIframeStatusCardOptions = {
layout: 'horizontal' | 'vertical';
width?: number;
height?: number;
};