Skip to content

Conversation

@juanjcardona13
Copy link
Contributor

@juanjcardona13 juanjcardona13 commented Nov 29, 2025

Description

This PR adds support for displaying Figma design links in example components. Examples can now include an example-meta block with a Figma URL that will be displayed as an action button in the example toolbar.

The exampleMeta computed property was designed with extensibility in mind, allowing for future integrations with other tools such as Storybook.

Changes

  • Example.vue: Added exampleMeta computed property to parse meta data from examples and figmaLink computed property to extract Figma URLs
  • vuetify.ts: Added Figma icon alias to the Vuetify plugin configuration
  • en.json: Added view-in-figma i18n translation key
  • vite.config.mts: Added support for example-meta block processing in the Vite build configuration
  • misc-readonly.vue: Added example-meta block with Figma link as a demonstration

Benefits

  • Provides easy access to Figma designs directly from documentation examples
  • Maintains consistency with existing example action buttons (Playground, GitHub)
  • Follows the same pattern as other example metadata (playground-resources, playground-setup)

Testing

  • Verified that the Figma button appears when an example includes an example-meta block with a figma property
  • Confirmed the button is hidden when no Figma link is provided
  • Tested the button opens the Figma link in a new tab
  • Verified i18n translation works correctly

Add support for displaying Figma design links in example
components. Examples can now include an example-meta block
with a figma URL that will be displayed as an action button
in the example toolbar.

The exampleMeta computed property was designed with
extensibility in mind, allowing for future integrations
with other tools such as Storybook.

- Add exampleMeta computed property to parse meta data
- Add figma icon alias to vuetify plugin
- Add view-in-figma i18n translation
- Add example-meta block support in vite config
- Add example-meta to v-btn readonly example
@juanjcardona13 juanjcardona13 force-pushed the docs/example-figma-links branch from 08f85b6 to 7820654 Compare November 29, 2025 06:19
@juanjcardona13 juanjcardona13 changed the base branch from dev to master November 29, 2025 20:05
- Add proper TypeScript types for component with extended properties
- Remove unnecessary 'as any' type assertion
- Add undefined check for component.value in playgroundLink
- Simplify figmaLink computed property
@juanjcardona13 juanjcardona13 changed the title feat(docs): add Figma link support to examples docs: add Figma link support to examples Dec 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants