start.md

BindKraft Javascript (BindKraftJS)

This is the start page of the BindKraftJS documentation. See the sections below for links to overviews, tutorials and references.

Contents at a glance

• General overviews - general articles about concepts and architecture.
• Tutorials - tutorial articles.
• References - links to class references and articles describing specific features, separated into sections: core, view, windowing, system and other.
• Integration - articles about integration of BindKraftJS with the server side software.

General overviews

BindKraft - general overview of the concept, architecture and philosophy of the platform.

Additional overviews of specific features are listed in the "References" section further in this document.

Tutorials

Not yet included in this documentation.

References and thematic articles

OOP in BindKraft (overview articles)

• OOP in BindKraftJS
• OOP Conventions
• OOP Helpers
• Runtime documentation and annotation

Core OOP classes and interfaces reference - The core classes forming the platform on non-visual conceptual level. Building blocks used widely.

• Operations
• Memory FS
• Writing interface implementers
• Connectors
• BKUrl
• Initializers

Miscellaneous core features:

• Translators
• Mergers
• Value checkers
• Defaults

View level classes and interfaces reference - The classes that build the UI basics - data binding, validation etc.

• Templates
• Writing UI classes (components)
• data-class - data-class={...}
• Binding syntax - data-bind-something={...} and data-on-event={...}
  • Bindings - overview and usage discussion
  • Target expressions
• Markers - data-context-border="true", data-template-root="true" etc.
• Using formatters
• Formatters - creating

Windowing classes and interfaces reference - The classes forming the windowing subsystem.

• Window behaviors
• Window message handling

System classes and interfaces reference - The system, app, daemon and API forming elements of the OOP.

• SysShell overview
• Local API
• List of system Local API
• System settings |
• BKInit - instance configuration

Data types/formats - the structures for various purposes. Non-strict Javscript data consisting of objects, arrays and values arranged according to the conventions described in the section.

Others - Specific classes and interfaces that do not fit into other categories.

• Settings, Persistence, State and shared data pieces

• Preliminary - Partial documentation of classes that are under construction. These will move elsewhere once they become ready. This section is mostly for people involved in the BindKraft core development.

Integration

Platform utility - A module where implementations of a tiny set of integration routines is placed. This module provides the glue needed to put BindKraftJS on top of the specific server side software and technology. Optional set of additional integration conveniences is also placed there. The module has to exist in any BindKraft setup.

Advanced topics

These articles require intimate knowledge of BindKraftJS architecture.

Local (Managed) proxy building