Skip to content

Commit bb67331

Browse files
authored
Update snap-components.mdx (#112)
1 parent 21e6a8c commit bb67331

File tree

1 file changed

+4
-8
lines changed

1 file changed

+4
-8
lines changed

fern/docs/pages/references/snap-components.mdx

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ Snap components are defined in the snap-in manifest file. DevRev UI renders thes
66

77
Each snap-component has the following properties:
88

9-
- `surface` : the surfaces where the snap component can be displayed. Currently, only `issue` is supported. // TODO: Confirm this.
9+
- `surface` : the surfaces where the snap component can be displayed. Currently, only `issue` is supported. {/* TODO: Confirm this. */}
1010
- `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.
11-
<!-- - `snap_kit_body` : the initial body of the snap kit action that will be rendered when the snap component is loaded. -->
11+
{/* - `snap_kit_body` : the initial body of the snap kit action that will be rendered when the snap component is loaded. */}
1212

13-
<!-- - `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. -->
13+
{/* - `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. */}
1414

1515
```yaml
1616
functions:
@@ -27,7 +27,7 @@ snap_components:
2727
description: Test Case Details
2828
surface: issue
2929
snap_kit_action_name: show_test_cases
30-
<!-- initializer: upgrade_test_function_1 -->
30+
{/* initializer: upgrade_test_function_1 */}
3131
snap_kit_body:
3232
{
3333
"snaps":[]
@@ -104,10 +104,6 @@ interface Event {
104104
}
105105
```
106106

107-
## Screenshots
108-
109-
<!-- ## Example for initializer -->
110-
111107
## List of surfaces
112108

113109
| Surface | Description |

0 commit comments

Comments
 (0)