@carbon/ibmdotcom-web-components 2.42.0 → 2.44.0

package/custom-elements.json

@@ -11511,22 +11511,18 @@
           "type": "string | undefined"
         },
         {
-          "name": "legalLinks",
-          "description": "The legal nav links.",
-          "type": "BasicLink[]",
-          "default": "[]"
+          "name": "links",
+          "type": "BasicLinkSet[] | undefined"
         },
         {
-          "name": "adjunctLinks",
+          "name": "legalLinks",
           "description": "The adjunct links.",
-          "type": "BasicLink[]",
-          "default": "[]"
+          "type": "BasicLink[] | undefined"
         },
         {
-          "name": "links",
+          "name": "adjunctLinks",
           "description": "The footer links.",
-          "type": "BasicLinkSet[]",
-          "default": "[]"
+          "type": "BasicLink[] | undefined"
         },
         {
           "name": "localeList",
@@ -11555,7 +11551,7 @@
     {
       "name": "c4d-footer-container",
       "path": "./src/components/footer/footer-container.ts",
-      "description": "Container component for masthead.",
+      "description": "Container component for footer.",
       "attributes": [
         {
           "name": "buttonLabel",
@@ -11670,22 +11666,18 @@
           "type": "string | undefined"
         },
         {
-          "name": "legalLinks",
-          "description": "The legal nav links.",
-          "type": "BasicLink[]",
-          "default": "[]"
+          "name": "links",
+          "type": "BasicLinkSet[] | undefined"
         },
         {
-          "name": "adjunctLinks",
+          "name": "legalLinks",
           "description": "The adjunct links.",
-          "type": "BasicLink[]",
-          "default": "[]"
+          "type": "BasicLink[] | undefined"
         },
         {
-          "name": "links",
+          "name": "adjunctLinks",
           "description": "The footer links.",
-          "type": "BasicLinkSet[]",
-          "default": "[]"
+          "type": "BasicLink[] | undefined"
         },
         {
           "name": "localeList",
@@ -23821,6 +23813,687 @@
         }
       ]
     },
+    {
+      "name": "c4d-video-player-composite-v7",
+      "path": "./src/components/video-player-v7/video-player-composite.ts",
+      "description": "Component that renders video player from its metadata, etc.",
+      "attributes": [
+        {
+          "name": "auto-play",
+          "description": "`true` to autoplay the videos.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "muted",
+          "description": "`true` load videos with sound muted.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "caption",
+          "description": "Optional custom video caption.",
+          "type": "\"\" | undefined"
+        },
+        {
+          "name": "video-description",
+          "description": "Custom video description. This property should only be set when `playing-mode=\"lightbox\"`.",
+          "type": "string | undefined"
+        },
+        {
+          "name": "hide-caption",
+          "description": "`true` to hide the caption.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "background-mode",
+          "description": "`true` to autoplay, mute, and hide player UI.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "intersection-mode",
+          "description": "Triggers playback on intersection with the viewport / carousel.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "button-position",
+          "description": "The position of the toggle playback button.",
+          "type": "BUTTON_POSITION",
+          "default": "\"bottom-right\""
+        },
+        {
+          "name": "video-id",
+          "description": "The video ID.",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "aspect-ratio",
+          "description": "The aspect ratio.",
+          "type": "\"\" | undefined"
+        },
+        {
+          "name": "isPlaying",
+          "description": "The current playback state",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "playing-mode",
+          "description": "The video player's mode showing Inline or Lightbox.",
+          "type": "VIDEO_PLAYER_PLAYING_MODE",
+          "default": "\"inline\""
+        },
+        {
+          "name": "thumbnail",
+          "description": "Optional custom video thumbnail",
+          "type": "\"\" | undefined"
+        },
+        {
+          "name": "video-thumbnail-width",
+          "description": "The video thumbnail width.",
+          "type": "number",
+          "default": "3"
+        },
+        {
+          "name": "isRTL",
+          "description": "Determines if the direction is right-to-left",
+          "type": "boolean",
+          "default": "false"
+        }
+      ],
+      "properties": [
+        {
+          "name": "autoPlay",
+          "attribute": "auto-play",
+          "description": "`true` to autoplay the videos.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "muted",
+          "attribute": "muted",
+          "description": "`true` load videos with sound muted.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "embeddedVideos",
+          "description": "The embedded Kaltura player element (that has APIs), keyed by the video ID.",
+          "type": "{ [videoId: string]: any; } | undefined"
+        },
+        {
+          "name": "caption",
+          "attribute": "caption",
+          "description": "Optional custom video caption.",
+          "type": "\"\" | undefined"
+        },
+        {
+          "name": "customVideoDescription",
+          "attribute": "video-description",
+          "description": "Custom video description. This property should only be set when `playing-mode=\"lightbox\"`.",
+          "type": "string | undefined"
+        },
+        {
+          "name": "formatCaption",
+          "description": "The formatter for the video caption, composed with the video name and the video duration.\nShould be changed upon the locale the UI is rendered with.",
+          "type": "(({ duration, name, }: { duration?: string | undefined; name?: string | undefined; }) => string) | undefined"
+        },
+        {
+          "name": "formatDuration",
+          "description": "The formatter for the video duration.\nShould be changed upon the locale the UI is rendered with.",
+          "type": "(({ duration }: { duration?: number | undefined; }) => string) | undefined"
+        },
+        {
+          "name": "hideCaption",
+          "attribute": "hide-caption",
+          "description": "`true` to hide the caption.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "backgroundMode",
+          "attribute": "background-mode",
+          "description": "`true` to autoplay, mute, and hide player UI.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "intersectionMode",
+          "attribute": "intersection-mode",
+          "description": "Triggers playback on intersection with the viewport / carousel.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "buttonPosition",
+          "attribute": "button-position",
+          "description": "The position of the toggle playback button.",
+          "type": "BUTTON_POSITION",
+          "default": "\"bottom-right\""
+        },
+        {
+          "name": "playbackTriggered",
+          "description": "Track when we have triggered initial playback.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "mediaData",
+          "description": "The video data, keyed by the video ID.",
+          "type": "{ [videoId: string]: MediaData; } | undefined"
+        },
+        {
+          "name": "videoId",
+          "attribute": "video-id",
+          "description": "The video ID.",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "aspectRatio",
+          "attribute": "aspect-ratio",
+          "description": "The aspect ratio.",
+          "type": "\"\" | undefined"
+        },
+        {
+          "name": "isPlaying",
+          "attribute": "isPlaying",
+          "description": "The current playback state",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "playingMode",
+          "attribute": "playing-mode",
+          "description": "The video player's mode showing Inline or Lightbox.",
+          "type": "VIDEO_PLAYER_PLAYING_MODE",
+          "default": "\"inline\""
+        },
+        {
+          "name": "thumbnail",
+          "attribute": "thumbnail",
+          "description": "Optional custom video thumbnail",
+          "type": "\"\" | undefined"
+        },
+        {
+          "name": "videoThumbnailWidth",
+          "attribute": "video-thumbnail-width",
+          "description": "The video thumbnail width.",
+          "type": "number",
+          "default": "3"
+        },
+        {
+          "name": "isRTL",
+          "attribute": "isRTL",
+          "description": "Determines if the direction is right-to-left",
+          "type": "boolean",
+          "default": "false"
+        }
+      ],
+      "cssParts": [
+        {
+          "name": "video-player",
+          "description": "The video player. Usage `c4d-video-player-composite-v7::part(video-player)`"
+        }
+      ]
+    },
+    {
+      "name": "c4d-video-player-container-v7",
+      "path": "./src/components/video-player-v7/video-player-container.ts",
+      "description": "Container component for video player.",
+      "attributes": [
+        {
+          "name": "auto-play",
+          "description": "`true` to autoplay the videos.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "muted",
+          "description": "`true` load videos with sound muted.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "caption",
+          "description": "Optional custom video caption.",
+          "type": "\"\" | undefined"
+        },
+        {
+          "name": "video-description",
+          "description": "Custom video description. This property should only be set when `playing-mode=\"lightbox\"`.",
+          "type": "string | undefined"
+        },
+        {
+          "name": "hide-caption",
+          "description": "`true` to hide the caption.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "background-mode",
+          "description": "`true` to autoplay, mute, and hide player UI.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "intersection-mode",
+          "description": "Triggers playback on intersection with the viewport / carousel.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "button-position",
+          "description": "The position of the toggle playback button.",
+          "type": "BUTTON_POSITION",
+          "default": "\"bottom-right\""
+        },
+        {
+          "name": "video-id",
+          "description": "The video ID.",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "aspect-ratio",
+          "description": "The aspect ratio.",
+          "type": "\"\" | undefined"
+        },
+        {
+          "name": "isPlaying",
+          "description": "The current playback state",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "playing-mode",
+          "description": "The video player's mode showing Inline or Lightbox.",
+          "type": "VIDEO_PLAYER_PLAYING_MODE",
+          "default": "\"inline\""
+        },
+        {
+          "name": "thumbnail",
+          "description": "Optional custom video thumbnail",
+          "type": "\"\" | undefined"
+        },
+        {
+          "name": "video-thumbnail-width",
+          "description": "The video thumbnail width.",
+          "type": "number",
+          "default": "3"
+        },
+        {
+          "name": "isRTL",
+          "description": "Determines if the direction is right-to-left",
+          "type": "boolean",
+          "default": "false"
+        }
+      ],
+      "properties": [
+        {
+          "name": "autoPlay",
+          "attribute": "auto-play",
+          "description": "`true` to autoplay the videos.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "muted",
+          "attribute": "muted",
+          "description": "`true` load videos with sound muted.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "caption",
+          "attribute": "caption",
+          "description": "Optional custom video caption.",
+          "type": "\"\" | undefined"
+        },
+        {
+          "name": "customVideoDescription",
+          "attribute": "video-description",
+          "description": "Custom video description. This property should only be set when `playing-mode=\"lightbox\"`.",
+          "type": "string | undefined"
+        },
+        {
+          "name": "formatCaption",
+          "description": "The formatter for the video caption, composed with the video name and the video duration.\nShould be changed upon the locale the UI is rendered with.",
+          "type": "(({ duration, name, }: { duration?: string | undefined; name?: string | undefined; }) => string) | undefined"
+        },
+        {
+          "name": "formatDuration",
+          "description": "The formatter for the video duration.\nShould be changed upon the locale the UI is rendered with.",
+          "type": "(({ duration }: { duration?: number | undefined; }) => string) | undefined"
+        },
+        {
+          "name": "hideCaption",
+          "attribute": "hide-caption",
+          "description": "`true` to hide the caption.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "backgroundMode",
+          "attribute": "background-mode",
+          "description": "`true` to autoplay, mute, and hide player UI.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "intersectionMode",
+          "attribute": "intersection-mode",
+          "description": "Triggers playback on intersection with the viewport / carousel.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "buttonPosition",
+          "attribute": "button-position",
+          "description": "The position of the toggle playback button.",
+          "type": "BUTTON_POSITION",
+          "default": "\"bottom-right\""
+        },
+        {
+          "name": "playbackTriggered",
+          "description": "Track when we have triggered initial playback.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "mediaData",
+          "description": "The video data, keyed by the video ID.",
+          "type": "{ [videoId: string]: MediaData; } | undefined"
+        },
+        {
+          "name": "videoId",
+          "attribute": "video-id",
+          "description": "The video ID.",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "aspectRatio",
+          "attribute": "aspect-ratio",
+          "description": "The aspect ratio.",
+          "type": "\"\" | undefined"
+        },
+        {
+          "name": "isPlaying",
+          "attribute": "isPlaying",
+          "description": "The current playback state",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "playingMode",
+          "attribute": "playing-mode",
+          "description": "The video player's mode showing Inline or Lightbox.",
+          "type": "VIDEO_PLAYER_PLAYING_MODE",
+          "default": "\"inline\""
+        },
+        {
+          "name": "thumbnail",
+          "attribute": "thumbnail",
+          "description": "Optional custom video thumbnail",
+          "type": "\"\" | undefined"
+        },
+        {
+          "name": "videoThumbnailWidth",
+          "attribute": "video-thumbnail-width",
+          "description": "The video thumbnail width.",
+          "type": "number",
+          "default": "3"
+        },
+        {
+          "name": "isRTL",
+          "attribute": "isRTL",
+          "description": "Determines if the direction is right-to-left",
+          "type": "boolean",
+          "default": "false"
+        }
+      ],
+      "cssParts": [
+        {
+          "name": "video-player",
+          "description": "The video player. Usage `c4d-video-player-composite-v7::part(video-player)`"
+        }
+      ]
+    },
+    {
+      "name": "c4d-video-player-v7",
+      "path": "./src/components/video-player-v7/video-player.ts",
+      "description": "Video player.",
+      "attributes": [
+        {
+          "name": "playing-mode",
+          "description": "The video player's mode showing Inline or Lightbox.",
+          "type": "VIDEO_PLAYER_PLAYING_MODE",
+          "default": "\"inline\""
+        },
+        {
+          "name": "intersection-mode",
+          "description": "Triggers playback on intersection with the viewport / carousel.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "isPlaying",
+          "description": "The current playback state, inherited from the parent.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "button-position",
+          "description": "The position of the toggle playback button.",
+          "type": "BUTTON_POSITION",
+          "default": "\"bottom-right\""
+        },
+        {
+          "name": "content-state",
+          "description": "The video player's content state.",
+          "type": "VIDEO_PLAYER_CONTENT_STATE",
+          "default": "\"thumbnail\""
+        },
+        {
+          "name": "duration",
+          "description": "The video duration.",
+          "type": "number | undefined"
+        },
+        {
+          "name": "hide-caption",
+          "description": "`true` to hide the caption.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "name",
+          "description": "The video name.",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "background-mode",
+          "description": "`true` to autoplay, mute video, and hide UI",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "auto-play",
+          "description": "`true` to autoplay",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "video-description",
+          "description": "Custom video description. This property should only be set when using `playing-mode=\"lightbox\"`",
+          "type": "string | undefined"
+        },
+        {
+          "name": "thumbnail-url",
+          "description": "The thumbnail URL.",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "video-id",
+          "description": "The video ID.",
+          "type": "string | undefined"
+        },
+        {
+          "name": "aspect-ratio",
+          "description": "Override default aspect ratio of `16x9`.\nAvailable aspect ratios:\n\n`16x9`, `9x16`, `2x1`, `1x2`, `4x3`, `3x4`, `1x1`",
+          "type": "string | undefined"
+        }
+      ],
+      "properties": [
+        {
+          "name": "playingMode",
+          "attribute": "playing-mode",
+          "description": "The video player's mode showing Inline or Lightbox.",
+          "type": "VIDEO_PLAYER_PLAYING_MODE",
+          "default": "\"inline\""
+        },
+        {
+          "name": "intersectionMode",
+          "attribute": "intersection-mode",
+          "description": "Triggers playback on intersection with the viewport / carousel.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "isPlaying",
+          "attribute": "isPlaying",
+          "description": "The current playback state, inherited from the parent.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "buttonPosition",
+          "attribute": "button-position",
+          "description": "The position of the toggle playback button.",
+          "type": "BUTTON_POSITION",
+          "default": "\"bottom-right\""
+        },
+        {
+          "name": "contentState",
+          "attribute": "content-state",
+          "description": "The video player's content state.",
+          "type": "VIDEO_PLAYER_CONTENT_STATE",
+          "default": "\"thumbnail\""
+        },
+        {
+          "name": "duration",
+          "attribute": "duration",
+          "description": "The video duration.",
+          "type": "number | undefined"
+        },
+        {
+          "name": "formatCaption",
+          "description": "The formatter for the video caption, composed with the video name and the video duration.\nShould be changed upon the locale the UI is rendered with.",
+          "type": "(...args: any[]) => string",
+          "default": "\"formatVideoCaption\""
+        },
+        {
+          "name": "formatDuration",
+          "description": "The formatter for the video duration.\nShould be changed upon the locale the UI is rendered with.",
+          "type": "(...args: any[]) => string",
+          "default": "\"formatVideoDuration\""
+        },
+        {
+          "name": "hideCaption",
+          "attribute": "hide-caption",
+          "description": "`true` to hide the caption.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "name",
+          "attribute": "name",
+          "description": "The video name.",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "backgroundMode",
+          "attribute": "background-mode",
+          "description": "`true` to autoplay, mute video, and hide UI",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "autoplay",
+          "attribute": "auto-play",
+          "description": "`true` to autoplay",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "customVideoDescription",
+          "attribute": "video-description",
+          "description": "Custom video description. This property should only be set when using `playing-mode=\"lightbox\"`",
+          "type": "string | undefined"
+        },
+        {
+          "name": "thumbnailUrl",
+          "attribute": "thumbnail-url",
+          "description": "The thumbnail URL.",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "videoId",
+          "attribute": "video-id",
+          "description": "The video ID.",
+          "type": "string | undefined"
+        },
+        {
+          "name": "aspectRatio",
+          "attribute": "aspect-ratio",
+          "description": "Override default aspect ratio of `16x9`.\nAvailable aspect ratios:\n\n`16x9`, `9x16`, `2x1`, `1x2`, `4x3`, `3x4`, `1x1`",
+          "type": "string | undefined"
+        },
+        {
+          "name": "shadowRootOptions",
+          "type": "{ delegatesFocus: boolean; mode: ShadowRootMode; }",
+          "default": "{\"delegatesFocus\":true}"
+        },
+        {
+          "name": "styles",
+          "default": "\"styles\""
+        }
+      ],
+      "cssParts": [
+        {
+          "name": "video",
+          "description": "The video. Usage `c4d-video-player::part(video)`"
+        },
+        {
+          "name": "button",
+          "description": "The play button. Usage `c4d-video-player::part(button)`"
+        },
+        {
+          "name": "image",
+          "description": "The thumbnail image. Usage `c4d-video-player::part(image)`"
+        },
+        {
+          "name": "play-video",
+          "description": "The play video icon. Usage `c4d-video-player::part(play-video)`"
+        },
+        {
+          "name": "video-container",
+          "description": "The video container. Usage `c4d-video-player::part(video-container)`"
+        },
+        {
+          "name": "caption",
+          "description": "The caption. Usage `c4d-video-player::part(caption)`"
+        }
+      ]
+    },
     {
       "name": "c4d-video-player-composite",
       "path": "./src/components/video-player/video-player-composite.ts",