Developer Docs
  • Getting Started
    • Xircus Web3 Protocol
    • Wallet & Authentication
    • Own Your Web3 Apps
    • Deploying Web3 Apps
    • Deploying NFT Collection
    • Minting and Importing NFTs
    • Listing and Selling NFTs
    • Supported Chains
  • Terminologies
    • DUST - Template System
      • The Presets
      • Dust
      • Dust React
      • Dust Chakra
      • Dust Radix
    • Carousel - Template Routers
    • Graphee
      • for TON Chain
  • Launching Your App
    • Quest Apps
    • NFT Marketplace Apps
    • eCommerce Apps
    • Launchpad Apps
  • TON Contracts
    • ⚡Quick Start
    • ⛏️Minter
      • Quick Start
      • Jetton
      • Jetton Non-Shard
      • NFT
      • SBT
      • Wallet
    • 🏪Marketplace
      • ⚡Quick Start
      • NFT Market
      • NFT Music Market
      • NFT Ticket Market
      • NFT Subscription Market
    • 🌱Launchpad
      • Getting Started
      • Auction Instant
      • Auction Pool
      • Auction Fair Launch
      • NFT Pre-Mint Auction Randomizer
      • NFT Allowlist Auction
    • 🛍️eCommerce
      • Checkout
      • Property Rentals
      • Fleet Courier
      • Delivery Pooling
      • Real World Assets
    • ⛰️Governance
      • Staking
      • Locker
      • Vesting Locker
      • Vesting Locker Simple
      • Proposals
    • ⛳Prediction
      • Getting Started
      • Optimistic Oracles
      • Prediction Market Factory
  • Platform Tools
    • 📃Smart Contracts
    • 🏅Open Quest & Leaderboard
    • ⚒️Web3 Minters
    • 🎨Generative NFT Creator
    • ✨NFT Auctioneer
  • App Templates
    • NFT Marketplace
    • Crowdfunding Launchpad
    • DeFi Exchange
    • Prediction Market
    • NFT Social
    • Token XP Campaigns
  • TON Blockchain
    • TON React
    • Telegram Mini dApps
  • React Reference
    • ⚡Quick Start
    • Hooks
      • useTonConnect
      • useUtils
      • useRegistry
      • useApp
      • useStorage
      • useTon
      • useTelegram
    • Recipes
      • Connect via Wallet Provider
      • Using Wallet Authentication
  • GraphQL Reference
    • ⚡Quick Start
    • Schemas
      • App
      • Currency
      • Account
      • Chain
      • Market
    • Methods
      • Get Apps
      • Get App
  • Core SDK Reference
    • ⚡Quick Start
    • Methods
  • Xircus CLI
    • ⚡Quick Start
    • Commands
      • Create
      • App
      • Contract
      • Skin
      • Module
  • DUST App Template Building
    • Getting Started
    • Dust Chakra Common
      • AppBrand / AppHeader
      • EditableFields
Powered by GitBook
On this page
  • Hooks
  • BlockRenderer
  1. Terminologies
  2. DUST - Template System

Dust

Consists of react hooks, utils and block renderers without dependency on any UI framework, this enables developers to partner dust with any UI framework such as dust-chakra, dust-radix, and more

PreviousThe PresetsNextDust React

Last updated 1 year ago

Hooks

Names
Description

useDust

The dust context state

useDustEnv

Identifies the development environment

useDustApp

Returns the current app data

useDustEdit

Identify if the app is currently on edit mode

useDustAdmin

Verifies the connected wallet address of the owner and instantly matches with the app owner

useDustHead

Each JS framework varies on how to render the head component, you can pass the head component and utilize it across your app

useDustScript

Similarly with useDustHead, just pass the Script component to the provider

useDustBlockEditor

useDustDesignerMode

True if DustProvider is set to designerMode=true. This is only for Hosting Providers (including Xircus) that has Designer tool enabled for creating and customizing app templates for sharing or monetization

useDustLayout

Layout system used by the app, e.g StackLayout, TONTelegramLayout

useDustPreset

State presets can be instantly applied to any component while still being customizable by merging with the component level theme. Presets are: Modern, Minimalist, Comic, Cyberpunk, Gradient, Glass

BlockRenderer

Renders the app configuration tree to UI components

Params
Description
Default

page

Current page

/

group

Section group, options are: header, footer, main, logoside, leftside, rightside

main

blocks

Block data passed from the app config tree

components

Components available for adding and generation. Each section is unique

mobile

false

renderOptions

renderBlockOption

Dust Extendable Templating System