Component Notes

About this plugin

Welcome to Component Notes

Easily add, modify and replace metadata for some or all components.

How to use

1. Select the property type (Annotation, Description or Documentation Link).
2. Choose your scope (Selection or Document).
3. Configure toggles as needed (Replace existing, Include variants, Include non-components for annotations, etc.).
4. Enter your content (supports markdown and line breaks).
5. Click "Apply" to update or "Remove" to clear.

Component Note Features

Metadata properties

1. Annotations: Add categorized annotations with markdown support.
2. Descriptions: Update component descriptions with markdown formatting.
3. Documentation Links: Set documentation URLs for components.

Adjusting metadata

1. Append (Default): Add to existing content (press Enter first to start on a new line).
2. Replace: Replace entire content.
3. Find & Replace: Update specific text within existing content.
4. Always New: Always create a new annotation (annotations only).

Scopes

1. Selection: Update selected components.
2. Document: Update all components/nodes in the file.

Custom options

1. Include variants: Include variant components from Component Sets.
2. Include non-components (Annotations): Enable annotations on frames, text nodes, shapes (ellipse, rectangle, polygon, star, vector, line), and instances, in addition to components.
3. Annotation categories: Organize annotations by category.
4. Remove: Clear property content from components.

Tips

1. Start your input with Enter to append on a new line.
2. Use Find & Replace to update specific text without replacing everything.
3. Select specific variants to update only those (not the parent Component Set).
4. Enable "Include non-components" for annotations to add annotations to frames, text, shapes, and other compatible nodes.

Limitations

1. Only works with Component and Component Set nodes (except annotations with ‘Include non-components’ enabled).
2. Documentation links must be valid URLs.
3. Variants are only included when explicitly selected or when "Include variants" is enabled.

Notes

1. Markdown formatting is preserved in annotations and descriptions.
2. Line breaks are supported, press Enter in the textarea to create new lines.
3. The plugin respects your selection: explicitly selected variants are always updated, regardless of toggle settings.