sn-controls-aurelia
Version:
Aurelia controls for sensenet ECM
224 lines (220 loc) • 13.1 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>sn-controls-aurelia</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="assets/js/search.js" data-base=".">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">sn-controls-aurelia</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="globals.html">Globals</a>
</li>
</ul>
<h1> sn-controls-aurelia</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<h1 id="sn-controls-aurelia">sn-controls-aurelia</h1>
<p><a href="https://gitter.im/SenseNet/SN7ClientAPI"><img src="https://img.shields.io/gitter/room/SenseNet/SN7ClientAPI.svg?style=flat" alt="Gitter chat"></a>
<a href="https://travis-ci.org/SenseNet/sn-controls-aurelia"><img src="https://travis-ci.org/SenseNet/sn-controls-aurelia.svg?branch=master" alt="Build Status"></a>
<a href="https://codecov.io/gh/SenseNet/sn-controls-aurelia"><img src="https://codecov.io/gh/SenseNet/sn-controls-aurelia/branch/master/graph/badge.svg" alt="codecov"></a>
<a href="https://www.codacy.com/app/SenseNet/sn-controls-aurelia?utm_source=github.com&utm_medium=referral&utm_content=SenseNet/sn-controls-aurelia&utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/323f6a8be16546aa802808897583295d" alt="Codacy Badge"></a>
<a href="https://www.npmjs.com/package/sn-controls-aurelia"><img src="https://img.shields.io/npm/v/sn-controls-aurelia.svg?style=flat" alt="NPM version"></a>
<a href="https://www.npmjs.com/package/sn-controls-aurelia"><img src="https://img.shields.io/npm/dt/sn-controls-aurelia.svg?style=flat" alt="NPM downloads"></a>
<a href="https://github.com/SenseNet/sn-controls-aurelia/LICENSE.txt"><img src="https://img.shields.io/github/license/SenseNet/sn-controls-aurelia.svg?style=flat" alt="License"></a>
<a href="https://github.com/semantic-release/semantic-release"><img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat" alt="semantic-release"></a>
<a href="http://commitizen.github.io/cz-cli/"><img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat" alt="Commitizen friendly"></a>
<a href="https://greenkeeper.io/"><img src="https://badges.greenkeeper.io/SenseNet/sn-controls-aurelia.svg" alt="Greenkeeper badge"></a></p>
<p>This package contains a collection of UI components and controls for <a href="https://www.sensenet.com/">sensenet ECM</a>, written in <a href="http://aurelia.io/">Aurelia Framewok</a></p>
<p><a href="https://github.com/SenseNet/sensenet/releases/tag/v7.0.0-beta3"><img src="https://img.shields.io/badge/sensenet-7.0.0--beta3%20tested-green.svg" alt="Sense/Net Services"></a></p>
<h2 id="usage-and-installation">Usage and installation</h2>
<p>You can install the latest version from NPM</p>
<pre><code>npm <span class="hljs-keyword">install</span> <span class="hljs-comment">--save sn-controls-aurelia</span>
</code></pre><p>You can import into your Aurelia application's entry point</p>
<pre><code class="lang-ts"><span class="hljs-keyword">import</span> { Repository } <span class="hljs-keyword">from</span> <span class="hljs-string">'sn-client-js'</span>;
<span class="hljs-comment">// ... your other imports</span>
<span class="hljs-keyword">export</span> <span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">configure</span>(<span class="hljs-params">aurelia: Aurelia</span>) </span>{
aurelia.use
.standardConfiguration()
.developmentLogging()
<span class="hljs-comment">// ... your other features and plugins</span>
.plugin(PLATFORM.moduleName(<span class="hljs-string">'aurelia-validation'</span>))
.plugin(PLATFORM.moduleName(<span class="hljs-string">'sn-controls-aurelia'</span>));
aurelia.container.registerSingleton(Repository.BaseRepository, <span class="hljs-function"><span class="hljs-params">()</span> =></span> {
<span class="hljs-keyword">const</span> repo = <span class="hljs-keyword">new</span> Repository.SnRepository(
{
RepositoryUrl: <span class="hljs-string">'https://my-sn7-instance'</span>,
});
<span class="hljs-keyword">return</span> repo;
});
<span class="hljs-keyword">await</span> aurelia.start();
<span class="hljs-keyword">await</span> aurelia.setRoot(PLATFORM.moduleName(<span class="hljs-string">'app'</span>));
}
</code></pre>
<p>If you are using Webpack, add these dependencies into your <em>webpack.config</em>'s <em>plugins</em> section:</p>
<pre><code class="lang-ts"><span class="hljs-keyword">new</span> ModuleDependenciesPlugin({
<span class="hljs-string">"sn-controls-aurelia"</span>: [
<span class="hljs-string">'./attributes/ContentDragCustomAttribute'</span>,
<span class="hljs-string">'./attributes/ContentDropCustomAttribute'</span>,
<span class="hljs-string">'./attributes/SettingsValidationCustomAttribute'</span>
]
}),
</code></pre>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="globals.html"><em>Globals</em></a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_enums_.html">"<wbr>Enums"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/attributes.html">Attributes</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/collectioncontrols.html">Collection<wbr>Controls</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/fieldcontrols.html">Field<wbr>Controls</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/navigationcontrols.html">Navigation<wbr>Controls</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/services.html">Services</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/viewcontrols.html">View<wbr>Controls</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/sn_controls_aurelia.html">sn-<wbr>controls-<wbr>aurelia</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
</body>
</html>