core minx panel construction and behaviour with sample layout and sample widget
JavaScript
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
samples
source
.gitignore
README.md

README.md

Minx

Intro

Mixing up javascript generated panels

A simple html 5 panel management library

The concept with this library is simple - you start with no html - inspired by Ext and Sencha touch. So it needs no selectors or DOM queries or DOM parsers.

Every thing is a panel (or content, outside of the framework) and a panel has a node which is a reference to the dom element - starting with a pseudo root panel which simply binds to document.body.

Each panel forms part of the tree of panels - which pretty much apes the Dom - or at least the Dom that the framework cares about.

I see minx as a basic window (panel) layout tool where each panel can contain 'widgets' the widgets are likely to be the things wired to the controller which gives them references to the relevant model - widgets they really only need to know about resize events from the panel manager

Organisation

Minx is pretty much composed of five parts ...

  • core - the panel and panel manager and a widget wrap panel.
  • more - more usefull things like buttons, title bars and popups - and common arrangements of them
  • widgets - widgets have some graphical behaviour and some data wrapped with a panel
  • layouts - arangements of multiple things made from 'more' things - a layout is not a panel itself
  • wrappers - classes that are specific to other frameworks and minx that allow them to work together, sharing models, views and events.

Core

  • PanelManager - a 'singleton' to factory create any registered panels.
  • Panel - The basics
  • PinnedPanel - The basics plus a bit of awareness of how to pin itself to parents and siblings.
  • Popup - a pinned panel with some popup style - with some default centering behaviour - but can be pinned.
  • WidgetPanel - A pinned panel that has a view and a model - generally expected to be pinned inside one of the above panels - but the client or overrides draw its content.

PanelManager

Which adds and removes panels and keeps a flat master list of all panels and assigns an ever increasing unique id to all panels - it does not do much else.

The master list of all panels is a simple id(string) -> object(Panel) map so it is v quick to grab a handle on a panel and get its DOM node.

Normally there is no need to know much about the panel manager, its mainly used when creating registered panels.

var panel = Minx.pm.add(); to create a new default pinned panel:

		// default panel added to the root panel (document.body)
		var panel = Minx.pm.add();
		panel.setSize(800, 600);

        
        var innerPanel = Minx.pm.add(panel);
        innerPanel.setSize(400, 270);

        panel.show();

Or create a registered panel type:

		var button = Minx.pm.add(null, 'button');

Panel

The basic unit is a panel - it knows about its parent and any child panels - it makes appropriate nodes in the dom at the right size and postition.

A panel is created by the

PinnedPanel

Panels dont know how they should behave wrt other panels including thier parents - but pinned panels do.

Pinned Panels can be pinned to thier parents or to siblings (other panels with the same parent) so are much more usefull in auto resizing applications - such as orientation aware applications.

  • sample - parent pinning some pinned panels Here is the Parent pinned example.

  • sample - parent and sibling pinning The first bits of this example shows a simple panel with a manually added title-bar, then removes that panel and adds a title-panel (see below) Here is the Sibling pinned example.

Popup

noting much - just a pinned panel with some centralising behaviour and a shaddow.

WidgetPanel

This thing will do most of the fun stuff - it is the most likely thing to be wrapped with some mvc aware type thing it is a view which knows about a model. It is essentially abstract - folk need to override this beastie and add model awareness and no how to munge the model into apropriate dom

More

Some specific panels that do typical things...

  • Button - styled like a button has an onClick.
  • ToolBar - dockable thin panel with toolbar styling - with an addButton utility function - could house mini widgets.
  • TitlePanel - a pinned panel with a top docked ToolBar.
  • InputPopupup - a popup, so centred by default with a bottom toolbar and a content pane to take widgets.

Button

button stuff.

ToolBar

Is a pinned Panel that can be docked to the top or bottom of a page so is pinned to the top, or bottom and left, and right edges of its parent, sets itself to a fixed height, and adds a class so that it can be styled as a title bar

  • Sample - The first bits of this example shows a simple panel with a manually added title-bar

Here is the Title-Panel sample.

Title-Panel

A simple panel containing a top docked tool-bar and a pinned-panel for content, which is pinned to its parent panel left, right, and to the bottom of the title-bar

The first example shows a simple panel with a manually added title-bar, then removes that panel and adds a title-panel

Here is the Title-Panel example.

InputPopup

A popup panel that looks like it can take input - it has a bottom pinned tool-bar.

Here is the Input popup panel example.

Layouts

A layout is an object that composes panels in a way that coordinates well

Widgets

V important

Wrappers

Wrappers really wrap widgets as it is these things that do all the real work - widgets have models and can display them

Orientation change and Pop Up

Call Minx.pm.init(true) to create a default main panel tht is orientation aware all main layout panels will be added to the main orientation aware panel.

Dyanmic repositioning pinning unpinning and popups based on viewport geometry Here is the Dynamic panel example.

Acknowledgements

For sizing info and general awesome advice Quirks Mode ViewPort Article.

Quick none wrapping OO Class stuff the fast small My.Class because it is prototype based it is slightly clunky to use more info - License