Merge pull request #265 from github/optional-dash

allow for customising prefix of @attr names
github · Jun 27, 2022 · 629ab22 · 629ab22
2 parents 31ad1a0 + b98b719
commit 629ab22
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 5 deletions.
diff --git a/src/attr.ts b/src/attr.ts
@@ -1,5 +1,5 @@
 import type {CustomElementClass} from './custom-element.js'
-import {dasherize} from './dasherize.js'
+import {mustDasherize} from './dasherize.js'
 import {meta} from './core.js'
 
 const attrKey = 'attr'
@@ -39,10 +39,12 @@ const initialized = new WeakSet<Element>()
 export function initializeAttrs(instance: HTMLElement, names?: Iterable<string>): void {
   if (initialized.has(instance)) return
   initialized.add(instance)
-  if (!names) names = meta(Object.getPrototypeOf(instance), attrKey)
+  const proto = Object.getPrototypeOf(instance)
+  const prefix = proto?.constructor?.attrPrefix ?? 'data-'
+  if (!names) names = meta(proto, attrKey)
   for (const key of names) {
     const value = (<Record<PropertyKey, unknown>>(<unknown>instance))[key]
-    const name = attrToAttributeName(key)
+    const name = mustDasherize(`${prefix}${key}`)
     let descriptor: PropertyDescriptor = {
       configurable: true,
       get(this: HTMLElement): string {
@@ -80,10 +82,12 @@ export function initializeAttrs(instance: HTMLElement, names?: Iterable<string>)
   }
 }
 
-const attrToAttributeName = (name: string) => `data-${dasherize(name)}`
-
 export function defineObservedAttributes(classObject: CustomElementClass): void {
   let observed = classObject.observedAttributes || []
+
+  const prefix = classObject.attrPrefix ?? 'data-'
+  const attrToAttributeName = (name: string) => mustDasherize(`${prefix}${name}`)
+
   Object.defineProperty(classObject, 'observedAttributes', {
     configurable: true,
     get() {

diff --git a/src/custom-element.ts b/src/custom-element.ts
@@ -16,4 +16,6 @@ export interface CustomElementClass {
   observedAttributes?: string[]
   disabledFeatures?: string[]
   formAssociated?: boolean
+
+  attrPrefix?: string
 }
diff --git a/test/attr.ts b/test/attr.ts
@@ -156,4 +156,25 @@ describe('Attr', () => {
       expect(instance.getAttributeNames()).to.include('data-clip-x')
     })
   })
+
+  describe('prefix', () => {
+    @controller
+    class PrefixAttrTest extends HTMLElement {
+      static attrPrefix = 'foo-'
+      @attr fooBarBazBing = 'a'
+      @attr URLBar = 'b'
+      @attr ClipX = 'c'
+    }
+
+    let instance: PrefixAttrTest
+    beforeEach(async () => {
+      instance = await fixture(html`<prefix-attr-test />`)
+    })
+
+    it('respects custom attrPrefix static member', async () => {
+      expect(instance.getAttributeNames()).to.include('foo-foo-bar-baz-bing')
+      expect(instance.getAttributeNames()).to.include('foo-url-bar')
+      expect(instance.getAttributeNames()).to.include('foo-clip-x')
+    })
+  })
 })