Line

You are reading the unreleased docs (next). See latest (v0.9)

ui/client/features/wizard/domain/ProjectPaths

Cockpit client (features), next. Source: ui/client/features/wizard/domain/ProjectPaths.ts.

Functions#

breadcrumbs(path): object[]

Defined in: ui/client/features/wizard/domain/ProjectPaths.ts:11

The folders leading to path, for a breadcrumb: 'src/app/home' -> [{name:'src',path:'src'}, ...].

Parameters#

path

string

Returns#

object[]


canChoose()#

canChoose(expects, entry): boolean

Defined in: ui/client/features/wizard/domain/ProjectPaths.ts:5

Whether an entry (or the folder being viewed) is an acceptable answer for a question: a route needs a folder that holds a page file, or a code file (a controller for a react-spa project); a folder question accepts any folder.

Parameters#

expects

PathExpectation

entry

Pick<ProjectTreeEntry, "kind" | "route">

Returns#

boolean


chooseHint()#

chooseHint(expects, entry): string

Defined in: ui/client/features/wizard/domain/ProjectPaths.ts:17

Why a row cannot be chosen, shown next to it; empty when it can.

Parameters#

expects

PathExpectation

entry

Pick<ProjectTreeEntry, "kind" | "route">

Returns#

string