@getblock/common

Consuming this package

@getblock/core is a peer dependency (>=0.0.84 <0.1.0) — it is not bundled. The host application installs exactly one copy of core, and this package's components use that copy, so a fix in core reaches the modals without a release here.

What each build format needs:

| Format | Requirement | |--------|-------------| | ESM (import) | Nothing extra. @getblock/core and @getblock/core/styles resolve through the bundler; core's stylesheet is pulled in automatically. | | CJS / AMD | @getblock/core/styles appears in the dependency list, so the consumer's build must be able to load a CSS module id. | | UMD via browser globals | Provide window.GetblockCore and window.Vue, and include core's stylesheet yourself — e.g. <link rel="stylesheet" href=".../@getblock/core/dist/style.css">. In that path the stylesheet dependency is passed as null, so nothing loads it for you and components render unstyled if it is missing. |

Both first-party consumers (getblock-web, getblock-account) use the ESM build and need none of the UMD steps.

Import the stylesheets once in the app entry:

import '@getblock/core/styles';   // primitives + gb-* utilities
import '@getblock/common/styles'; // this package's own component styles

Vue 3 + TypeScript + Vite

This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 <script setup> SFCs, check out the script setup docs to learn more.

Recommended IDE Setup

• VS Code + Volar

Type Support For .vue Imports in TS

Since TypeScript cannot handle type information for .vue imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in .vue imports (for example to get props validation when using manual h(...) calls), you can enable Volar's Take Over mode by following these steps:

1. Run Extensions: Show Built-in Extensions from VS Code's command palette, look for TypeScript and JavaScript Language Features, then right click and select Disable (Workspace). By default, Take Over mode will enable itself if the default TypeScript extension is disabled.
2. Reload the VS Code window by running Developer: Reload Window from the command palette.

You can learn more about Take Over mode here.