Docs: Add field overrides how-to guide for panel plugins#2606
Draft
leventebalogh wants to merge 1 commit intomainfrom
Draft
Docs: Add field overrides how-to guide for panel plugins#2606leventebalogh wants to merge 1 commit intomainfrom
leventebalogh wants to merge 1 commit intomainfrom
Conversation
Add a new how-to guide for implementing field override support in panel plugins, covering enabling standard field config, customizing standard options, defining custom field config properties, and accessing resolved config in the panel component.
Contributor
|
Hello! 👋 This repository uses Auto for releasing packages using PR labels. ✨ This PR can be merged. It will not be considered when calculating future versions of the npm packages and will not appear in the changelogs. |
leventebalogh
added
type/docs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes: https://github.com/grafana/grafana-catalog-team/issues/281
What changed?
Adds a new how-to guide under Panel plugins that explains how to implement field override support in a panel plugin. It covers:
useFieldConfig()FieldConfigEditorBuildercategory,showIf,shouldApply,hideFromDefaults/hideFromOverrides)Why?
There was no guidance on the developer portal about how to add field overrides to a panel plugin. This was a gap flagged in the catalog team issue above.