Skip to main content

Starter Package Overview

@vef-framework-react/starter is the package that turns VEF into a complete application shell.

It mainly covers three areas:

  1. application bootstrap (createApp, createApiClient)
  2. routing (createRouter, the route-option helpers)
  3. app-level state (useAppStore, useTabStore, useThemeStore)

The application shell itself — the root app, layouts, login, and status pages (App, Layout, Login, AccessDenied, Error, NotFound, NProgress, and friends) — is internal: none of it is exported from the package. It is configured entirely through the functions above; see Application Shell for the option shapes each one accepts. The one shell piece that is exported is the built-in PasswordChangeChallenge login-challenge renderer, which hosts register themselves — see Login challenges.

Page-level containers, form dialogs, tables, and the CRUD stack live in @vef-framework-react/components — see Components / CRUD.

Suggested Reading Order​

  1. Bootstrap and Routing
  2. Application Shell
  3. Stores and Types

Common Exports​

  • createApp
  • createApiClient
  • createRouter
  • createRootRouteOptions
  • createLayoutRouteOptions
  • createLoginRouteOptions
  • createAccessDeniedRouteOptions
  • setupAppVersionNotification
  • PasswordChangeChallenge / PASSWORD_CHANGE_CHALLENGE_TYPE
  • useAppStore / useTabStore / useThemeStore