Skip to content

storacha/console-toolkit

Repository files navigation

Storacha Console Toolkit

The Storacha Console Toolkit is a plug-and-play UI library that allows Web3 applications to embed Storacha console features directly inside their own interface—eliminating “double navigation” and redirect-based UX.

Overview

The toolkit provides both headless components (logic only, bring your own styling) and styled components (console-exact UI) for seamless integration. Partner applications can quickly add Storacha features such as authentication, space management, file uploads, content viewing, and sharing—by importing only the components they need.

Features

Authentication

  • Email-based authentication flow
  • Session management
  • Iframe support for embedded contexts

Space Management

  • SpacePicker - List and select spaces
  • SpaceCreator - Create public or private spaces
  • SpaceList - List content within a space with pagination
  • SpaceEnsurer - Ensure a space is selected before rendering

File Operations

  • UploadTool - Upload files, directories, or CAR files
    • Drag & drop support
    • Real-time progress tracking
    • Support for public and private spaces
    • Wrap in directory option
  • FileViewer - View file details (Root CID, Gateway URL, Shards)
  • File removal with shard management

Sharing

  • SharingTool - Share spaces via email or DID
  • Delegation management
  • Revocation support

Packages

@storacha/console-toolkit-react

Headless React components with no styling dependencies. Provides complete logic with full control over appearance.

@storacha/console-toolkit-react-styled

Pre-styled components matching the Storacha console design. Includes CSS and assets for immediate use.

Installation

# For headless components
npm install @storacha/console-toolkit-react @storacha/ui-core

# For styled components
npm install @storacha/console-toolkit-react-styled @storacha/console-toolkit-react @storacha/ui-core

Examples

Complete working examples are available in the examples/ directory:

  • headless-auth - Custom styling with headless components
  • styled-auth - Pre-styled components with console-exact UI
  • iframe-auth - Embedded authentication in iframe context
  • space-management - Complete space management with upload, file viewing, and sharing

Development

# Install dependencies
pnpm install

# Build packages
pnpm build


# Run examples
cd examples/headless-auth && pnpm dev
cd examples/styled-auth && pnpm dev
cd examples/iframe-auth && pnpm dev
cd examples/space-management && pnpm dev

License

Dual-licensed under MIT + Apache 2.0

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •