File: README.md

Recommend this page to a friend!
  Classes of Till Wehowski   .Flow   README.md   Download  
File: README.md
Role: Documentation
Content type: text/markdown
Description: Auxiliary data
Class: .Flow
General purpose library of objects
Author: By
Last change: Update README.md
Update README.md
Update README.md
Date: 5 years ago
Size: 5,231 bytes
 

Contents

Class file image Download

.Flow

Pluggable Websites and API

  • Project Status: Beta
  • Feel free to submit issues https://github.com/frdl/-Flow/issues or http://frdl.webfan.de/forum/testing.b-108.html

API-Reference

http://frdl.webfan.de/,flow.280.html#API-Reference

Quick Start

To start, in the HTML header section of your page include the following one-liner and your done so far:

<script type="text/javascript" src="http://api.webfan.de/api-d/4/js-api/library.js"></script>

Now you are able to acces and use the .Flow Modules and Plugins by your own WebApplication, for example by providing some HTML recognized by the library.

New Version...

...is work in progress. Default main-entry-point will be https://webfan.de/cdn/application/webfan/node_modules/webfan/homepagesystem.app To start with the new Version, in the HTML header section of your page include the following code and your done so far:

<script type="text/javascript">
(function() {
    'use strict';

    function exec(c, libUrl, libMetaUrl) {
        try {
            var execute = window.eval;
            execute(c);
        } catch (err) {
            if (!!console) {
                console.warn(err);
                console.trace(err);
                localStorage.removeItem(libUrl);
                localStorage.removeItem(libMetaUrl);
            }
        }
    }
    var libUrl = 'https://webfan.de/cdn/application/webfan/node_modules/webfan/homepagesystem.app';
    var libMetaUrl = libUrl + '#meta';
    var libCoreSource = localStorage.getItem(libUrl);
    var libMeta = localStorage.getItem(libMetaUrl);

    function LOAD() {
        if (window.XMLHttpRequest) {
            var request = new XMLHttpRequest();
        } else if (window.ActiveXObject) {
            var request = new ActiveXObject('Microsoft.XMLHTTP');
        }
        var loadLib = function() {
            if (request.readyState !== 4)
                return;
            libCoreSource = request.responseText;
            localStorage.setItem(libUrl, libCoreSource);
            localStorage.setItem(libMetaUrl, new Date().getTime());
            exec(libCoreSource, libUrl, libMetaUrl);
        };
        request.onreadystatechange = loadLib;
        try {
            request.open('GET', libUrl, true);
            request.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
            request.send();
        } catch (err) {
            if (!!console) {
                console.warn(err);
                (function() {
                    var h = document.getElementsByTagName("head", document)[0];
                    var s = document.createElement('script');
                    s.setAttribute('src', libUrl);
                    h.insertBefore(s, h.firstChild);
                }());
            }
        }
    }
    if ((null === libCoreSource || parseInt(libMeta) < new Date().getTime() - 24 60 60 * 1000 || parseInt(libMeta) < 1478981535857) && !!navigator.onLine) {
        LOAD();
    } else if (null === libCoreSource && !navigator.onLine) {
        window.addEventListener('online', function() {
            LOAD();
        }, true);
        return alert('The library was not installed, please go online to install it!');
    } else if (null !== libCoreSource) {
        exec(libCoreSource, libUrl, libMetaUrl);
    } else {
        alert('Error loading javascript library [unexpected exception]!');
    }
}());
</script>

Use or build websites and applications with...

  • ~~php~~ see https://github.com/frdl/webfan for serverside source code
  • HTML5
  • CSS
  • javascript * jQuery * AngularJS * TypeScript http://frdl.webfan.de/30.9.2016;,flow-library-added-typescript-support.308.html
  • API * CDN * SDK + Tools (in development) * Hosted Homepagesystem
  • modular * webfan-require * require function for browser https://github.com/frdl/webfan-require * require persistent cache: localStorage + (FileSystem API || node fs) * fallback to node.js require if available * jQuery $.lazy * W3C Widgets
  • Widget Engine http://frdl.webfan.de/widgets.286.html
  • WebIntents http://frdl.webfan.de/webfanintents.285.html
  • -webkit-webfan plug (ToDo)

Components

Once loaded the library by the code above, you can now add apps/widgets/components to your HTML. Read the following link to learn more about using components: https://github.com/frdl/-Flow/blob/master/components/README.md

Plugins

The API provides several plugins (also 3rd. party scripts) and functionalities, some of them can be lazy-loaded or may be jQuery Plugins. A list of available plugins will follow, but plugins should just be used by developers, please refer to the section "Components" of this readme if you just want to use "finalized widgets to go"!

Used by... (Examples and Demos)

  • My.Webfan http://app.domainundhomepagespeicher.webfan.de/cdn/application/webfan/app.html
  • Webfan Homepagesystem http://frdl.webfan.de
  • Widgets to go http://domainundhomepagespeicher.webfan.de/software-center/components/

License

(C) Till Wehowski - Alle Rechte vorbehalten

@license webdof http://look-up.webfan.de/webdof-license

@license BSD https://github.com/frdl/-Flow/blob/master/LICENSE.md

(C) The Copyright Holders [ MIT, BSD ]