Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

allow for customising prefix of @attr names #265

Merged
merged 1 commit into from
Jun 27, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions src/attr.ts
Original file line number Diff line number Diff line change
@@ -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'
Expand Down Expand Up @@ -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 {
Expand Down Expand Up @@ -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() {
Expand Down
2 changes: 2 additions & 0 deletions src/custom-element.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,6 @@ export interface CustomElementClass {
observedAttributes?: string[]
disabledFeatures?: string[]
formAssociated?: boolean

attrPrefix?: string
}
21 changes: 21 additions & 0 deletions test/attr.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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')
})
})
})