@voiden/extension-kit

voiden-wrapper

voiden-wrapper is the official wrapper library for building Voiden extensions. It provides the necessary hooks, utilities, and integration points to create powerful, composable, and reusable blocks that work seamlessly within the Voiden ecosystem.

✨ Features

• 🧩 Build custom extension blocks for Voiden
• 🧠 Hook into Voiden’s internal data model and event system
• ⚡ Provide dynamic behavior, UI components, or API interactions
• 🔌 Easy integration with Voiden’s local and offline runtime

📦 Installation

npm install voiden-wrapper

or with yarn:

yarn add voiden-wrapper

🛠️ Usage

Here's a basic example to get you started:

import { defineExtension } from 'voiden-wrapper';

export default defineExtension({
  name: 'example-extension',
  version: '1.0.0',
  setup(api) {
    api.registerBlock({
      type: 'custom-block',
      label: 'My Custom Block',
      render(props) {
        return `<div>Hello from custom block: ${props.content}</div>`;
      },
    });
  },
});

🧱 Extension Structure

A typical extension built with voiden-wrapper should export a default defineExtension() call that registers:

• Blocks (UI or logic)
• Actions (custom commands or behaviors)
• Hooks (events, state, or inter-block communication)

Voiden loads these extensions in a sandboxed local environment to ensure safety and composability.

🧪 Development

To develop and test your extension locally, use the Voiden CLI (coming soon) or load it directly into the desktop app via the Developer Tools → Load Extension panel.

📚 Documentation

Detailed extension APIs and examples are available on the Voiden Extension Docs (placeholder link).

🔒 Compatibility

This wrapper targets Voiden >=1.0.0. Breaking changes will be versioned according to semver.

🧠 Philosophy

Voiden extensions are designed to be:

• Composable: work well with other blocks
• Offline-first: no dependency on external services
• Hackable: give you full control over behavior

🤝 Contributing

We welcome contributions and bug reports. Please open issues or pull requests in the voiden-wrapper GitHub repository.

📄 License

MIT © VoidenHQ