giggles 0.3.13 → 0.3.14
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 +35 -3
- package/dist/index.js +3 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,10 +4,42 @@
|
|
|
4
4
|
|
|
5
5
|
# giggles
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
giggles is a batteries-included react framework for building terminal apps. built on ink, it handles focus, input routing, screen navigation, and theming out of the box so you can skip the plumbing and build.
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
inspired by the [charmbracelet](https://github.com/charmbracelet) ecosystem, it comes with a rich set of UI components, hooks for focus and navigation management, and terminal utilities for things like running shell commands.
|
|
10
|
+
|
|
11
|
+
to get started, run
|
|
12
|
+
|
|
13
|
+
```bash
|
|
10
14
|
npx create-giggles-app
|
|
11
15
|
```
|
|
12
16
|
|
|
13
|
-
see [giggles.zzzzion.com](https://giggles.zzzzion.com) for
|
|
17
|
+
see [giggles.zzzzion.com](https://giggles.zzzzion.com) for API documentation and live demos.
|
|
18
|
+
|
|
19
|
+
## sample ui components
|
|
20
|
+
|
|
21
|
+
for a full list of UI components, see [giggles/ui](https://giggles.zzzzion.com/ui). here are a few samples:
|
|
22
|
+
|
|
23
|
+
### viewport
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
### markdown
|
|
28
|
+
|
|
29
|
+
<img width="594" height="603" alt="image" src="https://github.com/user-attachments/assets/fc5648e4-3791-450c-adea-44b7057db071" />
|
|
30
|
+
|
|
31
|
+
### code block
|
|
32
|
+
|
|
33
|
+
supports syntax highlighting with [prism](https://prismjs.com/index.html#supported-languages). just import 'prism/language' and you're good to go!
|
|
34
|
+
|
|
35
|
+
<img width="548" height="527" alt="code-block" src="https://github.com/user-attachments/assets/fd9952fa-55ea-4c70-aadb-7a772d791018" />
|
|
36
|
+
|
|
37
|
+
### multi-select
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
### spinner
|
|
42
|
+
|
|
43
|
+
ported from [charmbracelet/bubbles](https://github.com/charmbracelet/bubbles/blob/master/spinner/spinner.go).
|
|
44
|
+
|
|
45
|
+
|
package/dist/index.js
CHANGED
|
@@ -1,6 +1,3 @@
|
|
|
1
|
-
import {
|
|
2
|
-
AlternateScreen
|
|
3
|
-
} from "./chunk-N2MMNJV3.js";
|
|
4
1
|
import {
|
|
5
2
|
FocusGroup,
|
|
6
3
|
FocusNodeContext,
|
|
@@ -15,6 +12,9 @@ import {
|
|
|
15
12
|
useKeybindingRegistry,
|
|
16
13
|
useKeybindings
|
|
17
14
|
} from "./chunk-CKA5JJ4B.js";
|
|
15
|
+
import {
|
|
16
|
+
AlternateScreen
|
|
17
|
+
} from "./chunk-N2MMNJV3.js";
|
|
18
18
|
import {
|
|
19
19
|
ThemeProvider,
|
|
20
20
|
useTheme
|