forked from SolidOS/solid-ui
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
243 lines (243 loc) · 12.4 KB
/
Copy pathindex.html
File metadata and controls
243 lines (243 loc) · 12.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>solid-ui</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">solid-ui</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>solid-ui</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<a href="#solid-ui" id="solid-ui" style="color: inherit; text-decoration: none;">
<h1>solid-ui</h1>
</a>
<p><a href="https://www.npmjs.com/package/solid-ui"><img src="https://img.shields.io/npm/v/solid-ui.svg" alt="NPM Package"></a></p>
<p>User Interface widgets and utilities for Solid</p>
<p>These are HTML5 widgets which connect to a solid store. Building blocks for solid-based apps.</p>
<p>Use:</p>
<pre><code> <span class="hljs-keyword">import</span> { ns, rdf, acl, aclControl, authn, <span class="hljs-keyword">create</span>, dom, icons, <span class="hljs-keyword">log</span>, matrix, media,
messageArea, infiniteMessageArea, pad, preferences, store, style, <span class="hljs-keyword">table</span>, tabs, utils, widgets, versionInfo
} <span class="hljs-keyword">from</span> <span class="hljs-string">'solid-ui'</span>
</code></pre><p>This has been a place to put any functionality from solid views which has been generalized to be usable in other views.</p>
<ul>
<li><p>Authentication UI: manage the user's logged in/out state.</p>
</li>
<li><p>Discovery: finding the users stuff, and leaving records of new things</p>
</li>
<li><p>Preferences: UI fo rmanaging a user's preefrences with two axes of defaults</p>
</li>
<li><p>An Access Control List widget for Solid ACL system</p>
</li>
<li><p>Acess Control Logic</p>
</li>
<li><p>Create a new object from modules/extensions which have registered their ability to create things</p>
</li>
<li><p>A <a href="https://solid.github.io/solid-ui/Documentation/forms-intro.html">form system</a>: Forms are defined in RDF, and create/edit RDF data, including form definitions</p>
</li>
<li><p>A collection of shortcut namespace objects for a selection of relevant RDF vocabularies.</p>
</li>
<li><p>Small atomic widgets (buttons etc) of which the others are constructed.</p>
</li>
<li><p>An error message panel</p>
</li>
</ul>
<p>Some of the larger controls include:</p>
<ul>
<li>A chat widget: add discussion to any object. Infinte scroll, embedded images, social reactions, etc etc</li>
<li>A people picker widget for choosing a set of people or an existing group</li>
<li>A general purpose table display with built-in facetted browsing</li>
<li>A two-dimentional matrix of editable live data extends in both domension.</li>
<li>A notepad of shared notes for real-time collaboration.</li>
<li>Drag and drop code for linking things and uploading files</li>
<li>A set of tabs for holding other widgets and arbitrary UI elements</li>
</ul>
<p>The typical style of the widgets is to know what data it has been derived from,
allow users to edit it, and to automatically sync with data as it changes in the future.
To see how these are used, see the panes which use them within the data browser.</p>
<p>The level of support for this varies.</p>
<p>See also: <a href="https://solid.github.io/solid-ui/Documentation/forms-intro.html">A short intoduction to the Form system</a></p>
<p>Contributions of bug fixes and new functionality, documentation, and tests are
always appreciated.</p>
</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/_acl_access_controller_.html">"acl/access-<wbr>controller"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_acl_access_groups_.html">"acl/access-<wbr>groups"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_acl_acl_.html">"acl/acl"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_acl_acl_control_.html">"acl/acl-<wbr>control"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_acl_add_agent_buttons_.html">"acl/add-<wbr>agent-<wbr>buttons"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_acl_index_.html">"acl/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_acl_styles_.html">"acl/styles"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_acl_types_.html">"acl/types"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_authn_authn_.html">"authn/authn"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_authn_index_.html">"authn/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_authn_types_.html">"authn/types"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_index_.html">"index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_jss_index_.html">"jss/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_versioninfo_.html">"version<wbr>Info"</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>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</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="https://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>