Skip to content
This repository was archived by the owner on Nov 28, 2023. It is now read-only.
Open
Changes from 1 commit
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
c5b68f4
Added button to arrange as Columns
johnman Mar 4, 2020
c9acc63
Added a basic example of trying to add a chart to a column
johnman Mar 4, 2020
6399347
Improvements to formatting and bug fix
johnman Mar 4, 2020
bf269d9
Update frame-styles.css
johnman Mar 12, 2020
6e9f49a
added native window extension as an example
rdepena Mar 11, 2020
f819624
added remote urls for the public.json
rdepena Mar 11, 2020
813f0fa
changed readme to reflect changes to provider customization
rdepena Mar 12, 2020
740de66
better english
rdepena Mar 12, 2020
90b0d90
better better english
rdepena Mar 12, 2020
010262e
Update README.md
rdepena Mar 12, 2020
7814e29
Added an app that has a main window
johnman Mar 24, 2020
4c21135
Updated readme.md
johnman Mar 24, 2020
df94b31
2nd sample - restore snapshot button didn't work
johnman Mar 24, 2020
68ab32c
Updated logic to demostrate context
johnman Mar 29, 2020
a782a9f
resatoring config file to working order.
johnman Mar 29, 2020
6293513
Updated the readme to include links
johnman Mar 29, 2020
3cc1a6f
Updated the readme
johnman Mar 29, 2020
aa28876
toggle fixed button
tgoc99 Apr 7, 2020
b4bad75
fixed becomes locked
tgoc99 Apr 8, 2020
664ef8b
Merge remote-tracking branch 'upstream/master'
johnman Apr 21, 2020
f5d3be1
Merge remote-tracking branch 'upstream/dev/tgoc99/fixed-layout'
johnman Apr 21, 2020
5bb79a4
Refactored the code a bit. Added clone, pin & lock
johnman Apr 23, 2020
334dee8
Updated readme
johnman Apr 24, 2020
ebd1422
MainWin now saves on close all from taskbar
johnman Apr 29, 2020
643e538
Updated to show marking a tab no close no drag
johnman May 5, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Updated readme
  • Loading branch information
johnman committed Apr 24, 2020
commit 334dee8bb145934de058bd4c7062c6d0c9dd183b
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ This project seed includes the following [Platform API](https://openfin.co/platf
* Examples of behavioral customization by overriding the Platform APIs
* Examples of how to make use of the platform apis to treat views inside of a window as a group with shared context and how messages could be shared to views in a group and how you can maintain that relationship when you pull out a view from a window (so there is a linked relationship).
* How your view can make use of knowledge of it being moved from window to window and how it can keep track of the number of views that exist so it can react to that.
* How you can lock all the views on a window (to prevent views from being pulled out or views dragged in and to also hide the tabs if they are not needed).
* How you can pin platform windows so they are always on top.


[![Click to watch on Vimeo](openfin-seed-project-first-demo-preview.png)](https://vimeo.com/401935037)
[Launch in OpenFin](https://openfin.github.io/start/?manifest=https%3A%2F%2Fopenfin.github.io%2Fplatform-api-project-seed%2Fpublic.json)
Expand Down Expand Up @@ -42,15 +45,16 @@ Provides examples of the following functionality:
* Adding a View to an existing Window
* Adding a View that makes use of shared context if there is more than one view of that type
* Adding a View in a new Window
* Saving the Window's current Layout
* Restoring the Window's current Layout
* Creating a regular OpenFin Window
* Saving/Restoring Platform Snapshots
* Applying a preset arrangement on the current window (Grid, Tabs, Rows, Columns)

##### title-bar
Provides examples of the following functionality:
* Draggable area
* Save/Restore a layout
* Lock/Unlock the current layout
* Pin/Unpin window so it is always on top
* Close/Maximize/Minimize buttons

### Provider
Expand Down Expand Up @@ -78,34 +82,32 @@ This example also shows how you can automatically capture layout when the main w
* A [stylesheet](https://developers.openfin.co/docs/platform-api#section-standard-window-customization) is linked in the [platform-window-main.html](platform-window-main.html) file, and allows for [main window visual customization](styles/frame-styles-window-main.css) with some additional classes that only apply to the main window. For a complete view of all properties, please refer to the [example stylesheet](https://github.com/openfin/layouts-v2-style-examples)

### Platform Window Common
The [platform-window-common.html](platform-window-common.html) file contains the [layout-container](https://developers.openfin.co/docs/platform-api#section-5-2-complete-window-customization) element and one custom element: `title-bar-save-restore`. This element, in conjunction with the [js/title-bar-save-restore.js](js/title-bar-save-restore.js) file, enable the following functionality:
The [platform-window-common.html](platform-window-common.html) file contains the [layout-container](https://developers.openfin.co/docs/platform-api#section-5-2-complete-window-customization) element and one custom element: `title-bar-common`. This element, in conjunction with the [js/title-bar-common.js](js/title-bar-common.js) file, enable the following functionality:

##### title-bar-save-restore
##### title-bar-common
Provides examples of the following functionality:
* Draggable area
* Save/Restore a layout
* Lock/Unlock the current layout
* Pin/Unpin window so it is always on top
* Clone the current window (experimental)
* Close/Maximize/Minimize buttons
* Lets you save the layout of the current window (session storage for the lifetime of the window)
* Lets you restore the saved layout to the current window (so you could add/remove views to this window by dragging them in/out and then restore to a previous layout)

### Platform Window Main
The [platform-window-main.html](platform-window-main.html) file contains the [layout-container](https://developers.openfin.co/docs/platform-api#section-5-2-complete-window-customization) element and two custom elements: `left-menu` and `title-bar-main`. These elements, in conjunction with the [js/left-menu.js](js/left-menu.js) and [js/title-bar-main.js](js/title-bar-main.js) files, enable the following functionality:

##### left-menu
Provides examples of the following functionality:
* Adding a View to an existing Window
* Adding a Context View that makes use of shared context and shared messaging if there is more than one view of that type
* Adding a View that makes use of shared context if there is more than one view of that type
* Adding a View in a new Window
* Adding a Context View in a new Window so that it is not linked to the main window.
* Saving the Window's current Layout
* Restoring the Window's current Layout
* Creating a regular OpenFin Window
* Saving/Restoring Platform Snapshots
* Applying a preset arrangement on the current window (Grid, Tabs, Rows, Columns)

##### title-bar-main
Provides examples of the following functionality:
* Draggable area
* Close/Maximize/Minimize buttons
* Same button functionality as title-bar-common (except clone)
* When you close the window it saves a snapshot of the layout for all windows before closing the whole application.
* If the window is being closed because you have dragged the last view out of the main window into another window it adds a default view and doesn't close the window. If you want to have layout support in the main window then you must have at least one default view that you always want displayed or you have a main window without layout support.
* If only one view remains in the main window then it removes the close icon via the custom class in the [main window visual customization](styles/frame-styles-window-main.css) stylesheet and removes it when more than one view exists.
Expand Down