Skip to content

Commit 9a0a864

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

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
@@ -84,6 +84,8 @@ export const permissionsMap: PermissionsMap = {
8484
setStyles: { permissions: ['canDesign'] },
8585
getTag: { permissions: ['canAccessCanvas'] },
8686
setTag: { permissions: ['canDesign'] },
87+
getDisplayName: { permissions: ['canAccessCanvas'] },
88+
setDisplayName: { permissions: ['canDesign'] },
8789
getAttribute: { permissions: ['canAccessCanvas'] },
8890
setAttribute: { permissions: ['canDesign'] },
8991
getAllAttributes: { permissions: ['canAccessCanvas'] },

src/examples/elements.ts

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -942,6 +942,38 @@ export const Elements = {
942942
}
943943
},
944944
},
945+
// Display Name Operations
946+
displayName: {
947+
getDisplayName: async () => {
948+
// Get Selected Element
949+
const element = await webflow.getSelectedElement()
950+
951+
if (element && element.displayName) {
952+
// Get the Navigator display name (null if using automatic name)
953+
const name = await element.getDisplayName()
954+
console.log(name) // e.g. 'Hero Wrapper' or null
955+
} else {
956+
console.log('No element selected or element does not support display names')
957+
}
958+
},
959+
960+
setDisplayName: async (displayName: string) => {
961+
// Get Selected Element
962+
const element = await webflow.getSelectedElement()
963+
964+
if (element && element.displayName) {
965+
// Set a custom Navigator label; pass '' to reset to automatic name
966+
await element.setDisplayName(displayName)
967+
968+
// Verify the update
969+
const name = await element.getDisplayName()
970+
console.log(name)
971+
} else {
972+
console.log('No element selected or element does not support display names')
973+
}
974+
},
975+
},
976+
945977
formInputOperations: {
946978
getInputName: async () => {
947979
const selectedElement = await webflow.getSelectedElement()

0 commit comments

Comments
 (0)