The virtual styling API, that is provided by the Virtual Styling Builder

interface IVirtualStylingApi {
    hide(): void;
    show(collection: Promise<Collection>, collectionReference: AssetReference, options?: {
        allowRRGATracking?: boolean;
        analytics?: Partial<IAnalyticProvider>[];
        closeable?: boolean;
        commerceProvider?: ICommerceProvider;
        consent?: ConsentState;
        customStyle?: string;
        fullscreen?: boolean;
        informationProvider?: Promise<Partial<IGarmentInformationProvider>>;
        layoutAlignment?: "left" | "right";
        noInternalAnalytics?: boolean;
        sharedState?: IShareState;
        useAvatarPlatform?: boolean;
    }): void;
}

Methods

Methods

  • Show the VSC.

    Parameters

    • collection: Promise<Collection>

      A promise that resolves to a collection

    • collectionReference: AssetReference

      A reference to the collection

    • Optionaloptions: {
          allowRRGATracking?: boolean;
          analytics?: Partial<IAnalyticProvider>[];
          closeable?: boolean;
          commerceProvider?: ICommerceProvider;
          consent?: ConsentState;
          customStyle?: string;
          fullscreen?: boolean;
          informationProvider?: Promise<Partial<IGarmentInformationProvider>>;
          layoutAlignment?: "left" | "right";
          noInternalAnalytics?: boolean;
          sharedState?: IShareState;
          useAvatarPlatform?: boolean;
      }

      Optional options to customize the VSC

      • OptionalallowRRGATracking?: boolean
      • Optionalanalytics?: Partial<IAnalyticProvider>[]
      • Optionalcloseable?: boolean
      • OptionalcommerceProvider?: ICommerceProvider
      • Optionalconsent?: ConsentState
      • OptionalcustomStyle?: string
      • Optionalfullscreen?: boolean
      • OptionalinformationProvider?: Promise<Partial<IGarmentInformationProvider>>
      • OptionallayoutAlignment?: "left" | "right"
      • OptionalnoInternalAnalytics?: boolean
      • OptionalsharedState?: IShareState
      • OptionaluseAvatarPlatform?: boolean

    Returns void