chore: remove 'variant' attribute from coach indicator

adobe · Sep 18, 2024 · e7428df · e7428df
1 parent 55dbbf9
commit e7428df
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 51 deletions.
diff --git a/packages/coachmark/coach-indicator.md b/packages/coachmark/coach-indicator.md
@@ -23,16 +23,16 @@ When looking to leverage the `CoachIndicator` base class as a type and/or for ex
 import { CoachIndicator } from '@spectrum-web-components/coachmark';
 ```
 
-## Variants
+## Static variants
 
-<sp-tabs selected="standard" auto label="Variant Options">
+<sp-tabs selected="standard" auto label="Static Options">
 <sp-tab value="standard">Standard</sp-tab>
 <sp-tab-panel value="standard">
 
 ```html
 <sp-coach-indicator></sp-coach-indicator>
-<sp-coach-indicator variant="dark"></sp-coach-indicator>
-<sp-coach-indicator variant="light"></sp-coach-indicator>
+<sp-coach-indicator static="dark"></sp-coach-indicator>
+<sp-coach-indicator static="light"></sp-coach-indicator>
 ```
 
 </sp-tab-panel>
@@ -41,8 +41,8 @@ import { CoachIndicator } from '@spectrum-web-components/coachmark';
 
 ```html
 <sp-coach-indicator quiet></sp-coach-indicator>
-<sp-coach-indicator quiet variant="dark"></sp-coach-indicator>
-<sp-coach-indicator quiet variant="light"></sp-coach-indicator>
+<sp-coach-indicator quiet static="dark"></sp-coach-indicator>
+<sp-coach-indicator quiet static="light"></sp-coach-indicator>
 ```
 
 </sp-tab-panel>

diff --git a/packages/coachmark/src/CoachIndicator.ts b/packages/coachmark/src/CoachIndicator.ts
@@ -12,7 +12,6 @@ governing permissions and limitations under the License.
 import {
     CSSResultArray,
     html,
-    PropertyValues,
     SpectrumElement,
     TemplateResult,
 } from '@spectrum-web-components/base';
@@ -33,32 +32,11 @@ export class CoachIndicator extends SpectrumElement {
     @property({ reflect: true })
     public static?: 'white' | 'black';
 
-    @property({ reflect: true })
-    public variant?: 'white' | 'black';
-
     protected override render(): TemplateResult {
         return html`
             <div class="ring"></div>
             <div class="ring"></div>
             <div class="ring"></div>
         `;
     }
-
-    protected override updated(changes: PropertyValues): void {
-        super.updated(changes);
-        if (
-            changes.has('variant') &&
-            (this.variant || typeof changes.get('variant'))
-        ) {
-            this.static = this.variant;
-            if (window.__swc.DEBUG) {
-                window.__swc.warn(
-                    this,
-                    `The "variant" attribute/property of <${this.localName}> have been deprecated. Use "static" with any of the same values instead. "variant" will be removed in a future release.`,
-                    'https://opensource.adobe.com/spectrum-web-components/components/badge/#fixed',
-                    { level: 'deprecation' }
-                );
-            }
-        }
-    }
 }
diff --git a/packages/coachmark/stories/coach-indicator-static.stories.ts b/packages/coachmark/stories/coach-indicator-static.stories.ts
@@ -22,14 +22,14 @@ export default {
 
 export const staticWhite = (): TemplateResult => {
     return html`
-        <sp-coach-indicator variant="white"></sp-coach-indicator>
-        <sp-coach-indicator quiet variant="white"></sp-coach-indicator>
+        <sp-coach-indicator static="white"></sp-coach-indicator>
+        <sp-coach-indicator quiet static="white"></sp-coach-indicator>
     `;
 };
 
 export const staticBlack = (): TemplateResult => {
     return html`
-        <sp-coach-indicator variant="black"></sp-coach-indicator>
-        <sp-coach-indicator quiet variant="black"></sp-coach-indicator>
+        <sp-coach-indicator static="black"></sp-coach-indicator>
+        <sp-coach-indicator quiet static="black"></sp-coach-indicator>
     `;
 };
diff --git a/packages/coachmark/test/coach-indicator.test.ts b/packages/coachmark/test/coach-indicator.test.ts
@@ -18,28 +18,15 @@ import { testForLitDevWarnings } from '../../../test/testing-helpers.js';
 describe('CoachIndicator', () => {
     testForLitDevWarnings(
         async () =>
-            await fixture<CoachIndicator>(
-                html`
-                    <sp-coach-indicator></sp-coach-indicator>
-                `
-            )
+            await fixture<CoachIndicator>(html`
+                <sp-coach-indicator></sp-coach-indicator>
+            `)
     );
     it('loads default coach-indicator accessibly', async () => {
-        const el = await fixture<CoachIndicator>(
-            html`
-                <sp-coach-indicator></sp-coach-indicator>
-            `
-        );
+        const el = await fixture<CoachIndicator>(html`
+            <sp-coach-indicator></sp-coach-indicator>
+        `);
         await elementUpdated(el);
         await expect(el).to.be.accessible();
     });
-    it('loads coach-indicator white static variant', async () => {
-        const el = await fixture<CoachIndicator>(
-            html`
-                <sp-coach-indicator variant="white"></sp-coach-indicator>
-            `
-        );
-        await elementUpdated(el);
-        expect(el.static == 'white').to.be.true;
-    });
 });