Skip to content

Commit 25f3d11

Browse files
committed
add points to add
1 parent 43a5a1b commit 25f3d11

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed
Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
Snap components enable adding custom UI components defined by snap-kit to the DevRev UI.
2-
These components can be used to display data or interact with the user.
1+
Snap components enable adding custom UI components defined by snap-kit to the DevRev UI.
2+
These components can be used to display data or interact with the user.
33
Snap components are defined in the snap-in manifest file. DevRev UI renders these components based on the defined configuration.
44

55
Each snap-component has the following properties:
66
- `surface` : the surfaces where the snap component can be displayed. Currently, only `issue` is supported. // TODO: Confirm this.
77
- `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.
88
- `snap_kit_body` : the initial body of the snap kit action that will be rendered when the snap component is loaded.
9-
- `initializer` : references a snap-kit action that can be called to initialize the snap component. This is useful when the snap component needs to be initialized with data from the server based on the context where it is being initialized.
9+
- `initializer` : references a function that can be called to initialize the snap component. This is useful when the snap component needs to be initialized with data from the server based on the context where it is being initialized.
1010

1111

1212
```
@@ -20,9 +20,20 @@ snap_components:
2020
description: Test Case Details
2121
surface: issue
2222
snap_kit_action_name: show_test_cases
23-
snap_kit_body:
23+
snap_kit_body:
2424
{
2525
"snaps":[]
2626
}
27-
28-
```
27+
28+
```
29+
30+
## Format of context passed to initializer
31+
32+
## Screenshots
33+
34+
## Example for initializer
35+
36+
## List of surfaces
37+
38+
## Referencing global inputs in snap components' snap-kit
39+

0 commit comments

Comments
 (0)