chore: migrate asset

TarunAdobe · TarunAdobe · commit 8500305cbc38 · 2025-11-06T16:30:49.000+05:30
diff --git a/2nd-gen/packages/core/components/asset/Asset.base.ts b/2nd-gen/packages/core/components/asset/Asset.base.ts
@@ -10,14 +10,69 @@
  * governing permissions and limitations under the License.
  */
 
+import { PropertyValues } from 'lit';
 import { property } from 'lit/decorators.js';
 
 import { SpectrumElement } from '@spectrum-web-components/core/shared/base/index.js';
 
+import type { AssetVariant } from './Asset.types.js';
+
+/**
+ * @slot - The content to render when no `variant` is provided (typically an <img> element)
+ */
 export abstract class AssetBase extends SpectrumElement {
+    // ─────────────────────────
+    //     API TO OVERRIDE
+    // ─────────────────────────
+
+    /**
+     * @internal
+     *
+     * A readonly array of all valid variants for the asset.
+     *
+     * This is an internal property for validations, stories, tests, etc.
+     * Because S1 and S2 could support different variants, the value of this
+     * property must be set in each subclass.
+     */
+    static readonly VARIANTS: readonly string[];
+
+    // ─────────────────
+    //     SHARED API
+    // ─────────────────
+
+    /**
+     * The variant of the asset. When not provided, slot content is rendered (e.g., an image).
+     */
     @property({ type: String, reflect: true })
-    public variant: 'file' | 'folder' | undefined;
+    public variant: AssetVariant | undefined;
 
+    /**
+     * Accessible label for the asset’s SVG variant.
+     */
     @property()
     public label = '';
+
+    // ──────────────────────
+    //     IMPLEMENTATION
+    // ──────────────────────
+
+    protected override updated(changes: PropertyValues): void {
+        super.updated(changes);
+        if (window.__swc?.DEBUG) {
+            const constructor = this.constructor as typeof AssetBase;
+            if (
+                typeof this.variant !== 'undefined' &&
+                !constructor.VARIANTS.includes(this.variant)
+            ) {
+                window.__swc.warn(
+                    this,
+                    `<${this.localName}> element expects the "variant" attribute to be one of the following:`,
+                    'https://opensource.adobe.com/spectrum-web-components/components/asset/',
+                    {
+                        issues: [...constructor.VARIANTS],
+                    }
+                );
+            }
+        }
+    }
 }
diff --git a/2nd-gen/packages/core/components/asset/Asset.types.ts b/2nd-gen/packages/core/components/asset/Asset.types.ts
@@ -0,0 +1,15 @@
+/**
+ * Copyright 2025 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+export const ASSET_VARIANTS = ['file', 'folder'] as const;
+
+export type AssetVariant = (typeof ASSET_VARIANTS)[number];
diff --git a/2nd-gen/packages/core/components/asset/index.ts b/2nd-gen/packages/core/components/asset/index.ts
@@ -10,3 +10,4 @@
  * governing permissions and limitations under the License.
  */
 export * from './Asset.base.js';
+export * from './Asset.types.js';
diff --git a/2nd-gen/packages/swc/components/asset/Asset.ts b/2nd-gen/packages/swc/components/asset/Asset.ts
@@ -11,62 +11,109 @@
  */
 
 import { CSSResultArray, html, TemplateResult } from 'lit';
+import { property } from 'lit/decorators.js';
+import { classMap } from 'lit/directives/class-map.js';
 
-import { AssetBase } from '@spectrum-web-components/core/components/asset';
+import {
+    ASSET_VARIANTS,
+    AssetBase,
+    type AssetVariant,
+} from '@spectrum-web-components/core/components/asset';
 
 import styles from './asset.css';
 
 const file = (label: string): TemplateResult => html`
     <svg
-        class="file"
+        class="spectrum-Asset-file"
         role="img"
         viewBox="0 0 128 128"
         aria-label=${label || 'File'}
     >
         <path
-            class="fileBackground"
+            class="spectrum-Asset-fileBackground"
             d="M24,126c-5.5,0-10-4.5-10-10V12c0-5.5,4.5-10,10-10h61.5c2.1,0,4.1,0.8,5.6,2.3l20.5,20.4c1.5,1.5,2.4,3.5,2.4,5.7V116c0,5.5-4.5,10-10,10H24z"
         ></path>
         <path
-            class="fileOutline"
+            class="spectrum-Asset-fileOutline"
             d="M113.1,23.3L92.6,2.9C90.7,1,88.2,0,85.5,0H24c-6.6,0-12,5.4-12,12v104c0,6.6,5.4,12,12,12h80c6.6,0,12-5.4,12-12V30.4C116,27.8,114.9,25.2,113.1,23.3z M90,6l20.1,20H92c-1.1,0-2-0.9-2-2V6z M112,116c0,4.4-3.6,8-8,8H24c-4.4,0-8-3.6-8-8V12c0-4.4,3.6-8,8-8h61.5c0.2,0,0.3,0,0.5,0v20c0,3.3,2.7,6,6,6h20c0,0.1,0,0.3,0,0.4V116z"
         ></path>
     </svg>
 `;
 
 const folder = (label: string): TemplateResult => html`
     <svg
-        class="folder"
+        class="spectrum-Asset-folder"
         role="img"
         viewBox="0 0 32 32"
         aria-label=${label || 'Folder'}
     >
         <path
-            class="folderBackground"
+            class="spectrum-Asset-folderBackground"
             d="M3,29.5c-1.4,0-2.5-1.1-2.5-2.5V5c0-1.4,1.1-2.5,2.5-2.5h10.1c0.5,0,1,0.2,1.4,0.6l3.1,3.1c0.2,0.2,0.4,0.3,0.7,0.3H29c1.4,0,2.5,1.1,2.5,2.5v18c0,1.4-1.1,2.5-2.5,2.5H3z"
         ></path>
         <path
-            class="folderOutline"
+            class="spectrum-Asset-folderOutline"
             d="M29,6H18.3c-0.1,0-0.2,0-0.4-0.2l-3.1-3.1C14.4,2.3,13.8,2,13.1,2H3C1.3,2,0,3.3,0,5v22c0,1.6,1.3,3,3,3h26c1.7,0,3-1.4,3-3V9C32,7.3,30.7,6,29,6z M31,27c0,1.1-0.9,2-2,2H3c-1.1,0-2-0.9-2-2V7h28c1.1,0,2,0.9,2,2V27z"
         ></path>
     </svg>
 `;
 
 /**
+ * Use an asset element to visually represent a file, folder, or image.
+ * File and folder representations center themselves within the available space.
+ * Images are contained to the element’s size and centered.
+ *
  * @element swc-asset
- * @slot - content to be displayed in the asset when an acceptable value for `file` is not present
+ * @slot - content to be displayed when no `variant` is set (typically an <img>)
+ *
+ * @example
+ * <swc-asset style="block-size: 128px">
+ *   <img class="spectrum-Asset-image" src="example.png" alt="Example image" />
+ * </swc-asset>
+ *
+ * @example
+ * <swc-asset variant="file" style="min-inline-size: 150px; block-size: 128px"></swc-asset>
+ *
+ * @example
+ * <swc-asset variant="folder" style="min-inline-size: 150px; block-size: 128px"></swc-asset>
  */
 export class Asset extends AssetBase {
+    // ────────────────────
+    //     API OVERRIDES
+    // ────────────────────
+
+    /**
+     * @internal
+     */
+    static override readonly VARIANTS = ASSET_VARIANTS;
+
+    /**
+     * The variant of the asset (S2-only values).
+     */
+    @property({ type: String, reflect: true })
+    public override variant: AssetVariant | undefined;
+
+    // ──────────────────────────────
+    //     RENDERING & STYLING
+    // ──────────────────────────────
+
     public static override get styles(): CSSResultArray {
         return [styles];
     }
 
     protected override render(): TemplateResult {
-        if (this.variant === 'file') {
-            return file(this.label);
-        } else if (this.variant === 'folder') {
-            return folder(this.label);
-        }
-        return html` <slot></slot> `;
+        return html`
+            <div
+                class=${classMap({
+                    ['spectrum-Asset']: true,
+                })}
+            >
+                ${this.variant === 'file'
+                    ? file(this.label)
+                    : this.variant === 'folder'
+                      ? folder(this.label)
+                      : html` <slot></slot> `}
+            </div>
+        `;
     }
 }
diff --git a/2nd-gen/packages/swc/components/asset/asset.css b/2nd-gen/packages/swc/components/asset/asset.css
@@ -1,91 +1,49 @@
-/**
+/*!
  * Copyright 2025 Adobe. All rights reserved.
+ *
  * This file is licensed to you under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ * of the License at <http://www.apache.org/licenses/LICENSE-2.0>
  *
  * Unless required by applicable law or agreed to in writing, software distributed under
  * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
 
-:host {
-    --spectrum-asset-folder-background: var(
-        --highcontrast-asset-icon-background-color,
-        var(
-            --mod-asset-folder-background-color,
-            var(--spectrum-asset-folder-background-color)
-        )
-    );
-    --spectrum-asset-file-background: var(
-        --highcontrast-asset-icon-background-color,
-        var(
-            --mod-asset-file-background-color,
-            var(--spectrum-asset-file-background-color)
-        )
-    );
-    --spectrum-asset-folder-outline: var(
-        --mod-asset-icon-outline-color,
-        var(--spectrum-asset-icon-outline-color)
-    );
-    --spectrum-asset-file-outline: var(
-        --mod-asset-icon-outline-color,
-        var(--spectrum-asset-icon-outline-color)
-    );
-
+.spectrum-Asset {
+    display: flex;
+    align-items: center;
+    justify-content: center;
     inline-size: 100%;
     block-size: 100%;
-    justify-content: center;
-    align-items: center;
-    display: flex;
-
-    --spectrum-asset-folder-background-color: var(
-        --system-asset-folder-background-color
-    );
-    --spectrum-asset-file-background-color: var(
-        --system-asset-file-background-color
-    );
-    --spectrum-asset-icon-outline-color: var(--system-asset-icon-outline-color);
 }
 
-::slotted(*) {
+.spectrum-Asset-image {
     max-inline-size: 100%;
     max-block-size: 100%;
     object-fit: contain;
-    transition: opacity var(--spectrum-animation-duration-100);
 }
 
-.file,
-.folder {
-    inline-size: max(48px, min(100%, 80px));
-    inline-size: max(
-        var(--mod-asset-icon-min-width, 48px),
-        min(100%, var(--mod-asset-icon-max-width, 80px))
-    );
+.spectrum-Asset-folder,
+.spectrum-Asset-file {
+    inline-size: clamp(48px, 100%, 80px);
     block-size: 100%;
     margin: 20px;
-    margin: var(--mod-asset-icon-margin, 20px);
-}
-
-.folderBackground {
-    fill: var(--spectrum-asset-folder-background);
 }
 
-.fileBackground {
-    fill: var(--spectrum-asset-file-background);
+.spectrum-Asset-folderBackground {
+    fill: var(--spectrum-gray-200);
 }
 
-.folderOutline {
-    fill: var(--spectrum-asset-folder-outline);
+.spectrum-Asset-fileBackground {
+    fill: var(--spectrum-gray-25);
 }
 
-.fileOutline {
-    fill: var(--spectrum-asset-file-outline);
+.spectrum-Asset-folderOutline {
+    fill: var(--spectrum-gray-500);
 }
 
-@media (forced-colors: active) {
-    :host {
-        --highcontrast-asset-icon-background-color: currentcolor;
-    }
+.spectrum-Asset-fileOutline {
+    fill: var(--spectrum-gray-500);
 }
diff --git a/2nd-gen/packages/swc/components/asset/stories/asset.stories.ts b/2nd-gen/packages/swc/components/asset/stories/asset.stories.ts
