Skip to content

Latest commit

 

History

History
42 lines (31 loc) · 1.81 KB

File metadata and controls

42 lines (31 loc) · 1.81 KB

@tok/generation

The primary package for generating projects via a configuration file. It offers presets that can be easily extended within the configuration file.

  1. Components
  2. Presets
  3. Plugins
  4. Tokens
  5. Use
  6. Bootstrap
  7. DefineConfig
  8. Root

The main generation function. It will create all the necessary parameters, plugins, routes, and mount the app

It is responsible for:

  1. Importing global styles from @tok/ui.
  2. Mounting AlertsPlugin from @tok/ui.
  3. Mounting CurrencyPlugin from @tok/ui.
  4. Mounting TokI18nPlugin from @tok/i18n.
  5. Handling router errors to reload your app after a new release of the onboarding.
  6. Ensuring that users stay within defined routes if they attempt to navigate to an unknown route.

A helper function solely intended to provide TypeScript definitions for your config, without containing any logic (for now)

The primary component in the generation process. It is responsible for:

  1. Automatically resolving the theme from Telegram.
  2. Handling BackButton navigation.
  3. Listening for the first interaction on the page to trigger the start of a video if necessary.
  4. Defining supported localizations.
  5. Notifying Telegram when the app is ready to use (after localization is loaded).
  6. Ensuring the app is always expanded upon loading.
  7. Wraping your entire app with Root component from @tok/ui