Skip to content

Update snap-components.mdx #112

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 12, 2024
Merged

Update snap-components.mdx #112

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions fern/docs/pages/references/snap-components.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ Snap components are defined in the snap-in manifest file. DevRev UI renders thes

Each snap-component has the following properties:

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

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

```yaml
functions:
Expand All @@ -27,7 +27,7 @@ snap_components:
description: Test Case Details
surface: issue
snap_kit_action_name: show_test_cases
<!-- initializer: upgrade_test_function_1 -->
{/* initializer: upgrade_test_function_1 */}
snap_kit_body:
{
"snaps":[]
Expand Down Expand Up @@ -104,10 +104,6 @@ interface Event {
}
```

## Screenshots

<!-- ## Example for initializer -->

## List of surfaces

| Surface | Description |
Expand Down