@caido/sdk-frontend 0.0.2 → 0.35.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +44 -2
- package/package.json +1 -1
- package/src/types/__generated__/graphql-sdk.d.ts +19331 -0
- package/src/types/commands.d.ts +2 -2
- package/src/types/index.d.ts +7 -10
- package/src/types/menu.d.ts +13 -8
- package/src/types/navigation.d.ts +16 -0
- package/src/types/window.d.ts +9 -0
package/README.md
CHANGED
|
@@ -1,2 +1,44 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
<div align="center">
|
|
2
|
+
<img width="1000" alt="image" src="https://user-images.githubusercontent.com/6225588/211916659-567751d1-0225-402b-9141-4145c18b0834.png">
|
|
3
|
+
|
|
4
|
+
<br />
|
|
5
|
+
<br />
|
|
6
|
+
<a href="https://caido.io/">Website</a>
|
|
7
|
+
<span> • </span>
|
|
8
|
+
<a href="https://dashboard.caido.io/">Dashboard</a>
|
|
9
|
+
<span> • </span>
|
|
10
|
+
<a href="https://docs.caido.io/" target="_blank">Docs</a>
|
|
11
|
+
<span> • </span>
|
|
12
|
+
<a href="https://links.caido.io/roadmap">Roadmap</a>
|
|
13
|
+
<span> • </span>
|
|
14
|
+
<a href="https://github.com/caido/caido/tree/main/brand">Branding</a>
|
|
15
|
+
<span> • </span>
|
|
16
|
+
<a href="https://links.caido.io/www-discord" target="_blank">Discord</a>
|
|
17
|
+
<br />
|
|
18
|
+
<hr />
|
|
19
|
+
</div>
|
|
20
|
+
|
|
21
|
+
## 👋 Frontend SDK
|
|
22
|
+
|
|
23
|
+
[](https://www.npmjs.com/package/@caido/sdk-frontend)
|
|
24
|
+
|
|
25
|
+
This is repository for the Caido frontend SDK.
|
|
26
|
+
|
|
27
|
+
The design pattern is heavily influenced by the VSCode SDK and works mainly with the `Command` concept.
|
|
28
|
+
|
|
29
|
+
```typescript
|
|
30
|
+
import { Caido } from "@caido/sdk-frontend";
|
|
31
|
+
|
|
32
|
+
Caido.commands.register("my-command", {
|
|
33
|
+
name: "My Command",
|
|
34
|
+
run: (context) => {
|
|
35
|
+
// Do something
|
|
36
|
+
},
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
Caido.commandPalette.register("my-command");
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## 💚 Community
|
|
43
|
+
|
|
44
|
+
Come join our [Discord](https://links.caido.io/www-discord) community and connect with other Caido users! We'd love to have you as part of the conversation and help with any questions you may have.
|