Skip to content

Commit 9b951c3

Browse files
committed
DEVREL-2723: Example for getDisplayName and setDisplayName
1 parent 1f104cb commit 9b951c3

File tree

2 files changed

+34
-0
lines changed

2 files changed

+34
-0
lines changed

src/components/PermissionsMap.tsx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,8 @@ export const permissionsMap: PermissionsMap = {
8181
setStyles: { permissions: ['canDesign'] },
8282
getTag: { permissions: ['canAccessCanvas'] },
8383
setTag: { permissions: ['canDesign'] },
84+
getDisplayName: { permissions: ['canAccessCanvas'] },
85+
setDisplayName: { permissions: ['canDesign'] },
8486
getAttribute: { permissions: ['canAccessCanvas'] },
8587
setAttribute: { permissions: ['canDesign'] },
8688
getAllAttributes: { permissions: ['canAccessCanvas'] },

src/examples/elements.ts

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -923,6 +923,38 @@ export const Elements = {
923923
}
924924
},
925925
},
926+
// Display Name Operations
927+
displayName: {
928+
getDisplayName: async () => {
929+
// Get Selected Element
930+
const element = await webflow.getSelectedElement()
931+
932+
if (element && element.displayName) {
933+
// Get the Navigator display name (null if using automatic name)
934+
const name = await element.getDisplayName()
935+
console.log(name) // e.g. 'Hero Wrapper' or null
936+
} else {
937+
console.log('No element selected or element does not support display names')
938+
}
939+
},
940+
941+
setDisplayName: async (displayName: string) => {
942+
// Get Selected Element
943+
const element = await webflow.getSelectedElement()
944+
945+
if (element && element.displayName) {
946+
// Set a custom Navigator label; pass '' to reset to automatic name
947+
await element.setDisplayName(displayName)
948+
949+
// Verify the update
950+
const name = await element.getDisplayName()
951+
console.log(name)
952+
} else {
953+
console.log('No element selected or element does not support display names')
954+
}
955+
},
956+
},
957+
926958
formInputOperations: {
927959
getInputName: async () => {
928960
const selectedElement = await webflow.getSelectedElement()

0 commit comments

Comments
 (0)