Header menu logo issie

Renderer Module

Types

Type Description

Messages

Model

Functions and values

Function or value Description

appSubscriptions _model

Full Usage: appSubscriptions _model

Parameters:
Returns: Sub<Msg>

The application's subscriptions, in Elmish 4 form: a constant set of identified subscriptions, each returning its teardown. The set does not depend on the model, so each subscription is started exactly once, as with Elmish 3's Cmd.ofSub.

_model : Model
Returns: Sub<Msg>

attachExitHandler dispatch

Full Usage: attachExitHandler dispatch

Parameters:
    dispatch : Msg -> unit

dispatch : Msg -> unit

attachMenusAndKeyShortcuts dispatch

Full Usage: attachMenusAndKeyShortcuts dispatch

Parameters:
    dispatch : Msg -> unit

Returns: IDisposable

One-shot application setup, run as an Elmish subscription so it receives dispatch: attach the Electron menu, the exit handler, and read the user data. There is nothing to tear down - what it attaches lives as long as the app.

dispatch : Msg -> unit
Returns: IDisposable

devMenu dispatch

Full Usage: devMenu dispatch

Parameters:
    dispatch : Msg -> unit

Returns: MenuItemConstructorOptions

The only Electron menu Issie still has, and only in debug builds. Nothing here carries an accelerator, and nothing here should. Electron registers a menu item's accelerator globally and unconditionally, which is why the Sheet, Edit and View menus had to go: they took the key before anything could ask whether it made sense in that context. A menu with no accelerators takes nothing, so it can coexist with KeyBindings. Everything users need from the old menus is on the renderer's own menu bar - Project, Sheets, Edit and View in TopMenuView - or in a context menu.

dispatch : Msg -> unit
Returns: MenuItemConstructorOptions

getUserAppDir ()

Full Usage: getUserAppDir ()

Parameters:
    () : unit

Returns: string

Already in the bootstrap record, which main fills from the same app.getPath call the old get-user-data channel made - so this is now a lookup rather than a round trip.

() : unit
Returns: string

init ()

Full Usage: init ()

Parameters:
    () : unit

Returns: Model * Cmd<'a>
() : unit
Returns: Model * Cmd<'a>

isMac

Full Usage: isMac

Returns: bool
Returns: bool

makeCondItem cond label accelerator action

Full Usage: makeCondItem cond label accelerator action

Parameters:
    cond : bool
    label : string
    accelerator : string option
    action : KeyboardEvent -> unit

Returns: MenuItemConstructorOptions

make a conditional menu item from a condition, name, opt key to trigger, and action

cond : bool
label : string
accelerator : string option
action : KeyboardEvent -> unit
Returns: MenuItemConstructorOptions

makeCondRoleItem cond label accelerator role

Full Usage: makeCondRoleItem cond label accelerator role

Parameters:
    cond : bool
    label : string
    accelerator : string option
    role : MenuItemRole

Returns: MenuItemConstructorOptions

make conditional menu item from condition, name, opt key to trigger, and role

cond : bool
label : string
accelerator : string option
role : MenuItemRole
Returns: MenuItemConstructorOptions

makeDebugItem label accelerator option

Full Usage: makeDebugItem label accelerator option

Parameters:
    label : string
    accelerator : string option
    option : KeyboardEvent -> unit

Returns: MenuItemConstructorOptions

A menu item which is visible only if in debug mode (run dev or command line -D on binaries) and on windows.

label : string
accelerator : string option
option : KeyboardEvent -> unit
Returns: MenuItemConstructorOptions

makeElmItem label accelerator action

Full Usage: makeElmItem label accelerator action

Parameters:
    label : string
    accelerator : string
    action : unit -> unit

Returns: MenuItemConstructorOptions

Make

label : string
accelerator : string
action : unit -> unit
Returns: MenuItemConstructorOptions

makeItem label accelerator iAction

Full Usage: makeItem label accelerator iAction

Parameters:
    label : string
    accelerator : string option
    iAction : KeyboardEvent -> unit

Returns: MenuItemConstructorOptions

Make action menu item from name, opt key to trigger, and action.

label : string
accelerator : string option
iAction : KeyboardEvent -> unit
Returns: MenuItemConstructorOptions

makeMenu topLevel name table

Full Usage: makeMenu topLevel name table

Parameters:
Returns: MenuItemConstructorOptions

Make a new menu from a list of menu items

topLevel : bool
name : string
table : MenuItemConstructorOptions list
Returns: MenuItemConstructorOptions

makeMenuGen visible topLevel name table

Full Usage: makeMenuGen visible topLevel name table

Parameters:
Returns: MenuItemConstructorOptions

Make a new menu from a list of menu items

visible : bool
topLevel : bool
name : string
table : MenuItemConstructorOptions list
Returns: MenuItemConstructorOptions

makeRoleItem label accelerator role

Full Usage: makeRoleItem label accelerator role

Parameters:
    label : string
    accelerator : string option
    role : MenuItemRole

Returns: MenuItemConstructorOptions

Make role menu from name, opt key to trigger, and action.

label : string
accelerator : string option
role : MenuItemRole
Returns: MenuItemConstructorOptions

makeWinDebugItem label accelerator option

Full Usage: makeWinDebugItem label accelerator option

Parameters:
    label : string
    accelerator : string option
    option : KeyboardEvent -> unit

Returns: MenuItemConstructorOptions

A menu item which is visible only if in debug mode (run dev or command line -D on binaries) and on windows.

label : string
accelerator : string option
option : KeyboardEvent -> unit
Returns: MenuItemConstructorOptions

menuSeparator

Full Usage: menuSeparator

Returns: MenuItemConstructorOptions
Returns: MenuItemConstructorOptions

runMenuAction id

Full Usage: runMenuAction id

Parameters:
    id : string

Look up and run whatever main says was clicked.

id : string

softInitialise model dispatch

Full Usage: softInitialise model dispatch

Parameters:
    model : 'a
    dispatch : 'b

model : 'a
dispatch : 'b

update msg model

Full Usage: update msg model

Parameters:
Returns: Model * Cmd<Msg>
msg : Msg
model : Model
Returns: Model * Cmd<Msg>

view model dispatch

Full Usage: view model dispatch

Parameters:
Returns: ReactElement
model : Model
dispatch : Msg -> unit
Returns: ReactElement

view' model dispatch

Full Usage: view' model dispatch

Parameters:
Returns: ReactElement
model : Model
dispatch : Msg -> unit
Returns: ReactElement

Type something to start searching.