@gram-ai/elements 1.14.0 → 1.16.1
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/LICENSE +661 -0
- package/README.md +1 -32
- package/dist/components/FrontendTools/index.d.ts +4 -0
- package/dist/elements.cjs +20 -24
- package/dist/elements.css +1 -1
- package/dist/elements.js +4639 -5841
- package/dist/index-BqoFmyxX.cjs +60 -0
- package/dist/index-CVZt-xeH.js +14913 -0
- package/dist/index.d.ts +2 -0
- package/dist/lib/tools.d.ts +22 -0
- package/dist/server.cjs +16 -41
- package/dist/server.js +2058 -8569
- package/dist/types/index.d.ts +177 -2
- package/package.json +14 -17
- package/dist/components/assistant-ui/d3-renderer.d.ts +0 -5
- package/dist/index-DxNldiiY.js +0 -6560
- package/dist/index-IZN-i8ZU.cjs +0 -33
package/README.md
CHANGED
|
@@ -97,7 +97,7 @@ export const App = () => {
|
|
|
97
97
|
|
|
98
98
|
## Configuration
|
|
99
99
|
|
|
100
|
-
For complete configuration options and TypeScript type definitions, see the [
|
|
100
|
+
For complete configuration options and TypeScript type definitions, see the [API documentation](./docs/interfaces/ElementsConfig.md).
|
|
101
101
|
|
|
102
102
|
### Quick Configuration Example
|
|
103
103
|
|
|
@@ -125,16 +125,6 @@ export const App = () => {
|
|
|
125
125
|
}
|
|
126
126
|
```
|
|
127
127
|
|
|
128
|
-
### Key Configuration Areas
|
|
129
|
-
|
|
130
|
-
- **[ElementsConfig](./docs/interfaces/ElementsConfig.md)** - Main configuration interface
|
|
131
|
-
- **[ThemeConfig](./docs/interfaces/ThemeConfig.md)** - Visual appearance (color scheme, density, radius)
|
|
132
|
-
- **[WelcomeConfig](./docs/interfaces/WelcomeConfig.md)** - Welcome message and suggestions
|
|
133
|
-
- **[ModalConfig](./docs/interfaces/ModalConfig.md)** - Modal window settings (for `variant: 'widget'`)
|
|
134
|
-
- **[SidecarConfig](./docs/interfaces/SidecarConfig.md)** - Sidecar panel settings (for `variant: 'sidecar'`)
|
|
135
|
-
- **[ModelConfig](./docs/interfaces/ModelConfig.md)** - LLM model selection and picker
|
|
136
|
-
- **[ToolsConfig](./docs/interfaces/ToolsConfig.md)** - Custom tool result components
|
|
137
|
-
|
|
138
128
|
## Plugins
|
|
139
129
|
|
|
140
130
|
Plugins extend the Gram Elements library with custom rendering capabilities for specific content types. They allow you to transform markdown code blocks into rich, interactive visualizations and components.
|
|
@@ -235,27 +225,6 @@ To create your own plugins, see the comprehensive [Plugin Development Guide](./s
|
|
|
235
225
|
- Real-world examples
|
|
236
226
|
- Troubleshooting tips
|
|
237
227
|
|
|
238
|
-
## API Documentation
|
|
239
|
-
|
|
240
|
-
Full TypeScript API documentation is available in the [`docs`](./docs/README.md) directory. The documentation is automatically generated from source code and updated on every merge to main.
|
|
241
|
-
|
|
242
|
-
### Quick Links
|
|
243
|
-
|
|
244
|
-
- **[Complete API Reference](./docs/README.md)** - Full API documentation
|
|
245
|
-
- **[ElementsConfig](./docs/interfaces/ElementsConfig.md)** - Configuration options
|
|
246
|
-
- **[Chat Component](./docs/functions/Chat.md)** - Main chat component
|
|
247
|
-
- **[useGramElements Hook](./docs/functions/useGramElements.md)** - Access configuration
|
|
248
|
-
|
|
249
|
-
### Generating Documentation Locally
|
|
250
|
-
|
|
251
|
-
```bash
|
|
252
|
-
# Generate documentation
|
|
253
|
-
pnpm run docs
|
|
254
|
-
|
|
255
|
-
# Watch mode (regenerate on changes)
|
|
256
|
-
pnpm run docs:watch
|
|
257
|
-
```
|
|
258
|
-
|
|
259
228
|
## Contributing
|
|
260
229
|
|
|
261
230
|
We welcome pull requests to Elements. Please read the contributing guide.
|