Options
All
  • Public
  • Public/Protected
  • All
Menu

@combeenation/custom-js-utils

Index

Namespaces

Classes

Type aliases

Variables

Type aliases

ShareRequestData

ShareRequestData: { embedUrl?: string; graphicComponentName?: string; imageUrl?: string; ogAuthor?: string; ogDescription?: string; ogTitle?: string }

Type declaration

  • Optional embedUrl?: string

    Url of the parent page where the configurator is embedded.
    Will be integrated into the resulting copyUrl.

  • Optional graphicComponentName?: string

    The graphic will be converted to an image, as defined in the property Archive of the component

  • Optional imageUrl?: string

    Direct url to an image which will be part of the shareUrl.
    It's recommended to use the resulting url of {@link CfgnFiles.uploadImages}.

  • Optional ogAuthor?: string
  • Optional ogDescription?: string
  • Optional ogTitle?: string

ShareResultData

ShareResultData: { copyUrl: string; description?: string; imageUrl?: string; shareConfigurationId: string; shareUrl: string; title?: string }

Type declaration

  • copyUrl: string

    Url which will create a copy of the shared configuration

  • Optional description?: string
  • Optional imageUrl?: string
  • shareConfigurationId: string
  • shareUrl: string

    Url which is enhanced for sharing on social media by using "Open Graph" tags.
    If this isn't required we recommend to use the copyUrl.
    Please note that this url won't contain the optional embed/parent url, but it will still redirect to it when opened.

  • Optional title?: string

Variables

Const version

version: "@VERSION@" = ...

Generated using TypeDoc