Skip to main content

Stock runner package overview

The stock runner packages contain a collection of resources for both the runner and the builder part of Tripetto. They all have the same structure, making it easy to swap stock runners.

📖 Resources

So, what's included in the packages? Here's a list:

  • Runner library: First and foremost there is the runner UI (included is an ESM, ES5 and UMD version);
  • Runner locales: Locale JSON files to load the right locale for the runner (learn more);
  • Runner translations: Translations of the static labels and texts in the runner (learn more);
  • Builder blocks bundle: Ready-made bundle for the builder of all blocks used in the runner (learn more);
  • Builder blocks translations bundle: Ready-made bundle for the builder of all block translations (learn more);
  • Builder styles contract: Contract to instruct the builder how to manage the styles for the runner (learn more);
  • Builder l10n contract: Contract to instruct the builder how to manage the language settings and translations for the runner (learn more);
  • TypeScript typings: Fully supports TypeScript out-of-the-box.

📂 Folder index

DirectoryDescription
/runnerContains all runner related resources.
/runner/esmContains the ESM build of the runner.
/runner/es5Contains the ES5 build of the runner.
/runner/index.jsContains the UMD build of the runner (for direct use in browser environments).
/runner/typesContains the TypeScript typings for the runner.
/runner/localesContains the runner locale JSON files (learn more).
/runner/translationsContains the runner translation JSON files (learn more).
/builderContains all builder related resources.
/builder/esmContains the ESM build of the builder blocks bundle.
/builder/es5Contains the ES5 build of the builder blocks bundle.
/builder/index.jsContains the UMD build of the builder blocks bundle (for direct use in browser environments).
/builder/typesContains the TypeScript typings for the builder blocks bundle.
/builder/translationsContains the translation JSON files of the builder blocks bundle (learn more).
/builder/stylesContains the styles contract for the runner. This contract instructs the builder which style properties can be managed for the runner (learn more).
/builder/l10nContains the l10n contract for the runner. This contract instructs the builder which labels can be translated for the runner (learn more).
info

The runner packages include an export map to declare the modules. That should make it easy to import the right resources. For example, bundlers like webpack and Rollup will use it to automatically select the right resource based on the bundler configuration.