Skip to content

refactor(live-preview): migrate live-preview to signals #2278

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
spliffone wants to merge 1 commit into
base: main
Choose a base branch
from
Open

refactor(live-preview): migrate live-preview to signals #2278

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
196 changes: 96 additions & 100 deletions api-goldens/live-preview/index.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@

import { ActivatedRoute } from '@angular/router';
import { AfterViewInit } from '@angular/core';
import * as _angular_core from '@angular/core';
import { ElementRef } from '@angular/core';
import * as i0 from '@angular/core';
import * as i1 from '@angular/router';
import { InjectionToken } from '@angular/core';
import { ModuleWithProviders } from '@angular/core';
Expand Down Expand Up @@ -80,43 +80,43 @@ export class SiExampleViewerComponent {
// (undocumented)
activateTab(index: number): void;
// (undocumented)
activeTabIndex: number;
readonly activeTabIndex: _angular_core.WritableSignal<number>;
// (undocumented)
baseUrl: string;
readonly baseUrl: string;
// (undocumented)
dataId: string;
readonly dataId: _angular_core.WritableSignal<string>;
// (undocumented)
exampleUrl: string;
readonly exampleUrl: _angular_core.WritableSignal<string>;
// (undocumented)
get hasTabs(): boolean;
readonly hasTabs: _angular_core.Signal<boolean>;
// (undocumented)
get hasTabsMobile(): boolean;
readonly hasTabsMobile: _angular_core.Signal<boolean>;
// (undocumented)
isRTL: boolean;
readonly isRTL: _angular_core.WritableSignal<boolean>;
// (undocumented)
jsTemplate: string;
readonly jsTemplate: _angular_core.WritableSignal<string>;
// (undocumented)
locale?: string;
readonly locale: _angular_core.WritableSignal<string>;
// (undocumented)
mode: string;
readonly mode: _angular_core.WritableSignal<string>;
// (undocumented)
reactTemplate: string;
readonly reactTemplate: _angular_core.WritableSignal<string>;
// (undocumented)
readonly renderer: i0.Signal<SiLivePreviewRendererComponent>;
readonly renderer: _angular_core.Signal<SiLivePreviewRendererComponent>;
// (undocumented)
tabs: {
readonly tabs: _angular_core.WritableSignal<{
heading: string;
base: string;
example: string;
}[];
}[]>;
// (undocumented)
template: string;
readonly template: _angular_core.WritableSignal<string>;
// (undocumented)
theme: string;
readonly theme: _angular_core.WritableSignal<string>;
// (undocumented)
ticketBaseUrl: string;
readonly ticketBaseUrl: string;
// (undocumented)
vueTemplate: string;
readonly vueTemplate: _angular_core.WritableSignal<string>;
}

// @public (undocumented)
Expand All @@ -125,23 +125,23 @@ export class SiLivePreviewComponent implements OnInit, AfterViewInit, OnChanges
// (undocumented)
activateTab(tab: string): void;
// (undocumented)
activeTab: string;
readonly activeTab: _angular_core.WritableSignal<string>;
// (undocumented)
allowCopy: boolean;
// (undocumented)
allowFullscreen: boolean;
// (undocumented)
availableLocales: string[];
// (undocumented)
baseUrl: string;
readonly baseUrl: _angular_core.InputSignal<string>;
// (undocumented)
changeFramework(framework: string): void;
// (undocumented)
changeLocale(locale: string): void;
changeLocale(locale: string | null | undefined): void;
// (undocumented)
checkWebComponentsAvailable(): void;
// (undocumented)
readonly consoleElem: i0.Signal<ElementRef<any>>;
readonly consoleElem: _angular_core.Signal<ElementRef<any>>;
// (undocumented)
copyCode(): void;
// (undocumented)
Expand All @@ -151,29 +151,29 @@ export class SiLivePreviewComponent implements OnInit, AfterViewInit, OnChanges
// (undocumented)
editorCollapsed: boolean;
// (undocumented)
example?: string | null;
readonly example: _angular_core.InputSignal<string | null | undefined>;
// (undocumented)
exampleFullscreen: boolean;
// (undocumented)
frameworks: Map<string, string>;
readonly frameworks: Map<string, string>;
// (undocumented)
handleInProgressEvent(inProgress: boolean): void;
// (undocumented)
inProgress: boolean;
// (undocumented)
isFullscreen: boolean;
readonly isFullscreen: _angular_core.WritableSignal<boolean>;
// (undocumented)
isMobile: boolean;
// (undocumented)
isRTL: boolean;
readonly isRTL: _angular_core.ModelSignal<boolean>;
// (undocumented)
loadJs: boolean;
readonly loadJs: _angular_core.WritableSignal<boolean>;
// (undocumented)
loadReact: boolean;
readonly loadReact: _angular_core.WritableSignal<boolean>;
// (undocumented)
loadVue: boolean;
readonly loadVue: _angular_core.WritableSignal<boolean>;
// (undocumented)
locale?: string;
readonly locale: _angular_core.ModelSignal<string | null | undefined>;
// (undocumented)
localeApi: SiLivePreviewLocaleApi | null;
// (undocumented)
Expand All @@ -191,45 +191,45 @@ export class SiLivePreviewComponent implements OnInit, AfterViewInit, OnChanges
// (undocumented)
openTab(): void;
// (undocumented)
readonly reactVueElem: i0.Signal<ElementRef<any>>;
readonly reactVueElem: _angular_core.Signal<ElementRef<any>>;
// (undocumented)
renderingError: any;
// (undocumented)
rfsSelectionChanges(value: string): void;
// (undocumented)
rootFontSize: number | 'initial';
readonly rootFontSize: _angular_core.WritableSignal<number | "initial">;
// (undocumented)
rootFontSizes: number[];
readonly rootFontSizes: number[];
// (undocumented)
rtlSwitcher: boolean | undefined;
readonly rtlSwitcher: boolean | undefined;
// (undocumented)
selectedFramework: string;
// (undocumented)
showCopied: boolean;
// (undocumented)
showEditor: boolean;
// (undocumented)
switcherEnabled: boolean | undefined;
readonly switcherEnabled: boolean | undefined;
// (undocumented)
template: string;
readonly template: _angular_core.ModelSignal<string>;
// (undocumented)
readonly templateElem: i0.Signal<ElementRef<any>>;
readonly templateElem: _angular_core.Signal<ElementRef<any>>;
// (undocumented)
templateFromComponent(template?: string): void;
// (undocumented)
templateJs: string;
readonly templateJs: _angular_core.ModelSignal<string>;
// (undocumented)
templateReact: string;
readonly templateReact: _angular_core.ModelSignal<string>;
// (undocumented)
templateTs: string;
// (undocumented)
templateVue: string;
readonly templateVue: _angular_core.ModelSignal<string>;
// (undocumented)
theme: string;
readonly theme: _angular_core.ModelSignal<string>;
// (undocumented)
themeChange(theme: string): void;
// (undocumented)
ticketBaseUrl: string;
readonly ticketBaseUrl: _angular_core.InputSignal<string>;
// (undocumented)
ticketLinkBug: string;
// (undocumented)
Expand All @@ -243,9 +243,9 @@ export class SiLivePreviewComponent implements OnInit, AfterViewInit, OnChanges
// (undocumented)
toggleTheme(): void;
// (undocumented)
readonly typescriptElem: i0.Signal<ElementRef<any>>;
readonly typescriptElem: _angular_core.Signal<ElementRef<any>>;
// (undocumented)
webcomponents: boolean | undefined;
readonly webcomponents: boolean | undefined;
}

// @public
Expand Down Expand Up @@ -277,59 +277,56 @@ export interface SiLivePreviewConfig {
}

// @public (undocumented)
export class SiLivePreviewIframeComponent implements OnInit, OnChanges {
export class SiLivePreviewIframeComponent implements OnInit {
constructor();
// (undocumented)
baseUrl: string;
readonly baseUrl: _angular_core.InputSignal<string>;
// (undocumented)
deviceChanged(): void;
// (undocumented)
exampleUrl: string;
readonly exampleUrl: _angular_core.InputSignal<string>;
// (undocumented)
iFrameHeight?: string;
readonly iFrameHeight: _angular_core.InputSignal<string | undefined>;
// (undocumented)
iFrameWidth?: string;
readonly iFrameWidth: _angular_core.InputSignal<string | undefined>;
// (undocumented)
readonly inProgress: i0.OutputEmitterRef<boolean>;
readonly inProgress: _angular_core.OutputEmitterRef<boolean>;
// (undocumented)
isFullscreen: boolean;
readonly isFullscreen: _angular_core.InputSignal<boolean>;
// (undocumented)
isRTL?: boolean;
readonly isRTL: _angular_core.InputSignal<boolean | undefined>;
// (undocumented)
loadJs?: boolean;
readonly loadJs: _angular_core.InputSignal<boolean | undefined>;
// (undocumented)
loadReact?: boolean;
readonly loadReact: _angular_core.InputSignal<boolean | undefined>;
// (undocumented)
loadVue?: boolean;
readonly loadVue: _angular_core.InputSignal<boolean | undefined>;
// (undocumented)
locale?: string;
readonly locale: _angular_core.ModelSignal<string | null | undefined>;
// (undocumented)
readonly localeChange: i0.OutputEmitterRef<string>;
readonly logClear: _angular_core.OutputEmitterRef<void>;
// (undocumented)
readonly logClear: i0.OutputEmitterRef<void>;
readonly logMessage: _angular_core.OutputEmitterRef<string>;
// (undocumented)
readonly logMessage: i0.OutputEmitterRef<string>;
// (undocumented)
readonly logRenderingError: i0.OutputEmitterRef<any>;
readonly logRenderingError: _angular_core.OutputEmitterRef<any>;
// (undocumented)
openQrMenu(): void;
// (undocumented)
readonly previewIframe: i0.Signal<ElementRef<any> | undefined>;
readonly previewIframe: _angular_core.Signal<ElementRef<any> | undefined>;
// (undocumented)
reactVueTemplate?: string;
readonly reactVueTemplate: _angular_core.InputSignal<string | undefined>;
// (undocumented)
rootFontSize: number | 'initial';
readonly rootFontSize: _angular_core.InputSignal<number | "initial">;
// (undocumented)
template: string;
readonly template: _angular_core.InputSignal<string>;
// (undocumented)
readonly templateFromComponent: i0.OutputEmitterRef<string | undefined>;
readonly templateFromComponent: _angular_core.OutputEmitterRef<string | undefined>;
// (undocumented)
theme: string;
readonly theme: _angular_core.ModelSignal<string>;
// (undocumented)
readonly themeChange: i0.OutputEmitterRef<string>;
readonly ticketLinkBug: _angular_core.InputSignal<string>;
// (undocumented)
ticketLinkBug: string;
// (undocumented)
ticketLinkFeature: string;
readonly ticketLinkFeature: _angular_core.InputSignal<string>;
// (undocumented)
toggleLandscape(): void;
// (undocumented)
Expand Down Expand Up @@ -363,47 +360,46 @@ export { SiLivePreviewModule }
export { SiLivePreviewModule as SimplLivePreviewModule }

// @public (undocumented)
export class SiLivePreviewQrComponent implements AfterViewInit, OnDestroy, OnChanges {
export class SiLivePreviewQrComponent implements AfterViewInit, OnDestroy {
// (undocumented)
readonly closed: i0.OutputEmitterRef<void>;
readonly closed: _angular_core.OutputEmitterRef<void>;
// (undocumented)
qrImg: string;
readonly qrImg: _angular_core.Signal<string | null>;
// (undocumented)
qrShort: boolean;
readonly qrShort: _angular_core.Signal<boolean>;
// (undocumented)
url?: string;
readonly url: _angular_core.InputSignal<string | undefined>;
// (undocumented)
urlShort?: string;
readonly urlShort: _angular_core.InputSignal<string | undefined>;
}

// @public (undocumented)
export class SiLivePreviewRendererComponent implements OnChanges, OnDestroy {
export class SiLivePreviewRendererComponent implements OnDestroy {
constructor();
// (undocumented)
dataId: string;
readonly dataId: _angular_core.InputSignal<string>;
// (undocumented)
exampleUrl: string;
readonly exampleUrl: _angular_core.InputSignal<string>;
// (undocumented)
readonly inProgress: i0.OutputEmitterRef<boolean>;
readonly inProgress: _angular_core.OutputEmitterRef<boolean>;
// (undocumented)
readonly logClear: i0.OutputEmitterRef<void>;
readonly logClear: _angular_core.OutputEmitterRef<void>;
// (undocumented)
readonly logMessage: i0.OutputEmitterRef<string>;
readonly logMessage: _angular_core.OutputEmitterRef<string>;
// (undocumented)
readonly logRenderingError: i0.OutputEmitterRef<any>;
readonly logRenderingError: _angular_core.OutputEmitterRef<any>;
// (undocumented)
readonly react: i0.Signal<ElementRef<any>>;
readonly react: _angular_core.Signal<ElementRef<any>>;
// (undocumented)
recompile(): void;
// (undocumented)
readonly renderedExample: i0.Signal<ViewContainerRef>;
// (undocumented)
renderingDone: boolean;
readonly renderedExample: _angular_core.Signal<ViewContainerRef>;
// (undocumented)
readonly supportsLandscapeMode: i0.OutputEmitterRef<boolean>;
readonly supportsLandscapeMode: _angular_core.OutputEmitterRef<boolean>;
// (undocumented)
template: string;
readonly template: _angular_core.InputSignal<string>;
// (undocumented)
readonly templateFromComponent: i0.OutputEmitterRef<string | undefined>;
readonly templateFromComponent: _angular_core.OutputEmitterRef<string | undefined>;
}

// @public (undocumented)
Expand Down Expand Up @@ -432,25 +428,25 @@ export abstract class SiLivePreviewWebComponentService {
export class SiLivePreviewWrapperComponent {
constructor();
// (undocumented)
exampleUrl: string;
readonly exampleUrl: _angular_core.WritableSignal<string>;
// (undocumented)
loadJs: boolean;
readonly loadJs: _angular_core.WritableSignal<boolean>;
// (undocumented)
loadReact: boolean;
readonly loadReact: _angular_core.WritableSignal<boolean>;
// (undocumented)
loadVue: boolean;
readonly loadVue: _angular_core.WritableSignal<boolean>;
// (undocumented)
onClick(event: MouseEvent): void;
// (undocumented)
readonly renderer: i0.Signal<SiLivePreviewRendererComponent>;
readonly renderer: _angular_core.Signal<SiLivePreviewRendererComponent>;
// (undocumented)
sendMessage(type: string, message?: any): void;
// (undocumented)
template: string;
readonly template: _angular_core.WritableSignal<string>;
// (undocumented)
readonly webcomponentRenderer: i0.Signal<ElementRef<any>>;
readonly webcomponentRenderer: _angular_core.Signal<ElementRef<any>>;
// (undocumented)
webcomponentTemplateCode: string;
readonly webcomponentTemplateCode: _angular_core.WritableSignal<string>;
}

// @public
Expand Down
Loading
Loading