You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: fern/docs/pages/references/snap-components.mdx
+5-12Lines changed: 5 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,13 @@
1
-
# Snap Components
2
-
3
1
Snap components enable adding custom UI components defined by snap-kit to the DevRev UI.
4
2
These components can be used to display data or interact with the user.
5
3
Snap components are defined in the snap-in manifest file. DevRev UI renders these components based on the defined configuration.
6
4
7
5
Each snap-component has the following properties:
8
6
9
-
-`surface` : the surfaces where the snap component can be displayed. Currently, only `issue` is supported. // TODO: Confirm this.
10
-
-`snap_kit_action_name` : the name of the snap kit action that will be triggered when the action defined in the snap-kit of the snap component is interacted with.
-`surface` : The surface where the snap component can be displayed.
8
+
-`snap_kit_action_name` : The name of the action within the snap kit that is triggered when the snap component's defined action is engaged.
9
+
-`snap_kit_body` : The initial body content of the snap kit action that is rendered upon loading the snap component.
10
+
-`initializer` : Refers to a function that can be invoked to set up the snap component. This is particularly useful when the component needs to be initialized with server data, depending on the context in which it is being deployed.
0 commit comments