mirror of
https://github.com/rowyio/rowy.git
synced 2025-12-29 00:16:39 +01:00
remove typedoc build
This commit is contained in:
@@ -1 +0,0 @@
|
||||
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
|
||||
@@ -1,78 +0,0 @@
|
||||
:root {
|
||||
--light-hl-0: #0000FF;
|
||||
--dark-hl-0: #569CD6;
|
||||
--light-hl-1: #000000;
|
||||
--dark-hl-1: #D4D4D4;
|
||||
--light-hl-2: #0070C1;
|
||||
--dark-hl-2: #4FC1FF;
|
||||
--light-hl-3: #795E26;
|
||||
--dark-hl-3: #DCDCAA;
|
||||
--light-hl-4: #001080;
|
||||
--dark-hl-4: #9CDCFE;
|
||||
--light-hl-5: #AF00DB;
|
||||
--dark-hl-5: #C586C0;
|
||||
--light-hl-6: #098658;
|
||||
--dark-hl-6: #B5CEA8;
|
||||
--light-hl-7: #A31515;
|
||||
--dark-hl-7: #CE9178;
|
||||
--light-code-background: #F5F5F5;
|
||||
--dark-code-background: #1E1E1E;
|
||||
}
|
||||
|
||||
@media (prefers-color-scheme: light) { :root {
|
||||
--hl-0: var(--light-hl-0);
|
||||
--hl-1: var(--light-hl-1);
|
||||
--hl-2: var(--light-hl-2);
|
||||
--hl-3: var(--light-hl-3);
|
||||
--hl-4: var(--light-hl-4);
|
||||
--hl-5: var(--light-hl-5);
|
||||
--hl-6: var(--light-hl-6);
|
||||
--hl-7: var(--light-hl-7);
|
||||
--code-background: var(--light-code-background);
|
||||
} }
|
||||
|
||||
@media (prefers-color-scheme: dark) { :root {
|
||||
--hl-0: var(--dark-hl-0);
|
||||
--hl-1: var(--dark-hl-1);
|
||||
--hl-2: var(--dark-hl-2);
|
||||
--hl-3: var(--dark-hl-3);
|
||||
--hl-4: var(--dark-hl-4);
|
||||
--hl-5: var(--dark-hl-5);
|
||||
--hl-6: var(--dark-hl-6);
|
||||
--hl-7: var(--dark-hl-7);
|
||||
--code-background: var(--dark-code-background);
|
||||
} }
|
||||
|
||||
body.light {
|
||||
--hl-0: var(--light-hl-0);
|
||||
--hl-1: var(--light-hl-1);
|
||||
--hl-2: var(--light-hl-2);
|
||||
--hl-3: var(--light-hl-3);
|
||||
--hl-4: var(--light-hl-4);
|
||||
--hl-5: var(--light-hl-5);
|
||||
--hl-6: var(--light-hl-6);
|
||||
--hl-7: var(--light-hl-7);
|
||||
--code-background: var(--light-code-background);
|
||||
}
|
||||
|
||||
body.dark {
|
||||
--hl-0: var(--dark-hl-0);
|
||||
--hl-1: var(--dark-hl-1);
|
||||
--hl-2: var(--dark-hl-2);
|
||||
--hl-3: var(--dark-hl-3);
|
||||
--hl-4: var(--dark-hl-4);
|
||||
--hl-5: var(--dark-hl-5);
|
||||
--hl-6: var(--dark-hl-6);
|
||||
--hl-7: var(--dark-hl-7);
|
||||
--code-background: var(--dark-code-background);
|
||||
}
|
||||
|
||||
.hl-0 { color: var(--hl-0); }
|
||||
.hl-1 { color: var(--hl-1); }
|
||||
.hl-2 { color: var(--hl-2); }
|
||||
.hl-3 { color: var(--hl-3); }
|
||||
.hl-4 { color: var(--hl-4); }
|
||||
.hl-5 { color: var(--hl-5); }
|
||||
.hl-6 { color: var(--hl-6); }
|
||||
.hl-7 { color: var(--hl-7); }
|
||||
pre, code { background: var(--code-background); }
|
||||
File diff suppressed because it is too large
Load Diff
Binary file not shown.
|
Before Width: | Height: | Size: 9.4 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 28 KiB |
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
Load Diff
Binary file not shown.
|
Before Width: | Height: | Size: 480 B |
Binary file not shown.
|
Before Width: | Height: | Size: 855 B |
@@ -1,145 +0,0 @@
|
||||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>rowy</title><meta name="description" content="Documentation for rowy"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">rowy</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></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"><h1> rowy </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography"><p align="center">
|
||||
<img src="src/assets/logo-sticker.svg" alt="Rowy" height="69" />
|
||||
</p>
|
||||
|
||||
<h1 align="center">
|
||||
✨ Data x Code ✨ <br/>
|
||||
</h1>
|
||||
<h3 align="center">
|
||||
Modern Backend Stack
|
||||
</h3>
|
||||
<p align="center">
|
||||
Forget CLIs, configs, and DevOps. Focus on building your apps with a platform designed for developer productivity. Your production database (Firestore) in an Airtable-like UI with full coding extensibility via Cloud Functions visually in the browser.
|
||||
</p>
|
||||
|
||||
<div align="center">
|
||||
|
||||
<p><a href="https://discord.gg/fjBugmvzZP"><img src="https://img.shields.io/discord/853498675484819476?color=%234200FF&label=Chat%20with%20us&logo=discord&logoColor=%23FFFFFF&style=for-the-badge" alt="Discord"></a></p>
|
||||
<p align="center">
|
||||
<a href="http://www.rowy.io"><b>Website</b></a> •
|
||||
<a href="http://docs.rowy.io"><b>Documentation</b></a> •
|
||||
<a href="https://discord.gg/fjBugmvzZP"><b>Discord</b></a> •
|
||||
<a href="https://twitter.com/rowyio"><b>Twitter</b></a>
|
||||
</p>
|
||||
|
||||
<p><a href="https://github.com/rowyio/rowy/blob/main/LICENSE"><img src="https://img.shields.io/github/license/rowyio/rowy" alt="License"></a>
|
||||
<a href="https://github.com/rowyio/rowy/commits/rc"><img src="https://img.shields.io/github/last-commit/rowyio/rowy/rc" alt="Last commit"></a>
|
||||
<a href="https://github.com/rowyio/rowy/stargazers/"><img src="https://img.shields.io/github/stars/rowyio/rowy" alt="GitHub stars"></a></p>
|
||||
</div>
|
||||
<img width="100%" src="https://user-images.githubusercontent.com/307298/157184506-f94f3f5b-e6d3-49df-9a2c-f665511883f2.png" />
|
||||
|
||||
|
||||
<a href="#live-demo" id="live-demo" style="color: inherit; text-decoration: none;">
|
||||
<h2>Live Demo</h2>
|
||||
</a>
|
||||
<p>💥 Check out the <a href="https://demo.rowy.io/">live demo</a> of Rowy 💥 </p>
|
||||
|
||||
<a href="#quick-deploy" id="quick-deploy" style="color: inherit; text-decoration: none;">
|
||||
<h2>Quick Deploy</h2>
|
||||
</a>
|
||||
<p>Set up Rowy on your Google Cloud Platform project with this easy deploy button.</p>
|
||||
<p><a href="https://deploy.rowy.app/"><img src="https://deploy.cloud.run/button.svg" alt="Run on Google Cloud"></a></p>
|
||||
<p><a href="https://deploy.rowy.app/">https://deploy.rowy.app/</a></p>
|
||||
|
||||
<a href="#documentation" id="documentation" style="color: inherit; text-decoration: none;">
|
||||
<h2>Documentation</h2>
|
||||
</a>
|
||||
<p>You can find the full documentation with how-to guides and templates
|
||||
<a href="http://docs.rowy.io/">here</a>.</p>
|
||||
|
||||
<a href="#features" id="features" style="color: inherit; text-decoration: none;">
|
||||
<h2>Features</h2>
|
||||
</a>
|
||||
<p><a href="https://user-images.githubusercontent.com/307298/157185793-f67511cd-7b7b-4229-9589-d7defbf7a63f.mp4">https://user-images.githubusercontent.com/307298/157185793-f67511cd-7b7b-4229-9589-d7defbf7a63f.mp4</a></p>
|
||||
<!-- <img width="85%" src="https://firebasestorage.googleapis.com/v0/b/rowyio.appspot.com/o/publicDemo%2FRowy%20Website%20Video%20GIF%20Small.gif?alt=media&token=3f699a8f-c1f2-4046-8ed5-e4ff66947cd8" />
|
||||
-->
|
||||
|
||||
<a href="#powerful-spreadsheet-interface-for-firestore" id="powerful-spreadsheet-interface-for-firestore" style="color: inherit; text-decoration: none;">
|
||||
<h3>Powerful spreadsheet interface for Firestore</h3>
|
||||
</a>
|
||||
<ul>
|
||||
<li>CRUD operations</li>
|
||||
<li>Sort and filter by row values</li>
|
||||
<li>Lock, Freeze, Resize, Hide and Rename columns</li>
|
||||
<li>Multiple views for the same collection</li>
|
||||
<li>Bulk import or export data - csv, json</li>
|
||||
</ul>
|
||||
|
||||
<a href="#automate-with-cloud-functions-and-ready-made-extensions" id="automate-with-cloud-functions-and-ready-made-extensions" style="color: inherit; text-decoration: none;">
|
||||
<h3>Automate with cloud functions and ready made extensions</h3>
|
||||
</a>
|
||||
<ul>
|
||||
<li>Effortlessly build cloud functions on field level triggers right in the browser<ul>
|
||||
<li>Use any NPM modules or APIs</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>Connect to your favourite tool with pre-built extensions or create your own<ul>
|
||||
<li>SendGrid, Algolia, Twilio, Bigquery and more</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<a href="#rich-and-flexible-data-fields" id="rich-and-flexible-data-fields" style="color: inherit; text-decoration: none;">
|
||||
<h3>Rich and flexible data fields</h3>
|
||||
</a>
|
||||
<ul>
|
||||
<li><a href="https://docs.rowy.io/field-types/supported-fields">30+ fields supported</a><ul>
|
||||
<li>Basic types: Short Text, Long Text, Email, Phone, URL…</li>
|
||||
<li>Custom UI pickers: Date, Checkbox, Single Select, Multi Select…</li>
|
||||
<li>Uploaders: Image, File</li>
|
||||
<li>Rich Editors: JSON, Code, Rich Text (HTML)</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>Data validation, default values, required fields</li>
|
||||
<li>Action field: Clickable trigger for any Cloud Function</li>
|
||||
<li>Aggregate field: Populate cell with value aggregated from the row’s sub-table</li>
|
||||
<li>Connect Table: Get snapshot of data from another data table using Algolia</li>
|
||||
<li>Connect Service: Get data from any HTTP endpoint</li>
|
||||
</ul>
|
||||
|
||||
<a href="#collaborate-with-your-team" id="collaborate-with-your-team" style="color: inherit; text-decoration: none;">
|
||||
<h3>Collaborate with your team</h3>
|
||||
</a>
|
||||
<ul>
|
||||
<li>Granular table-level and field-level permission control<br>with custom user roles</li>
|
||||
<li>Built in user management</li>
|
||||
<li>Customizable views for different user roles</li>
|
||||
</ul>
|
||||
|
||||
<a href="#install" id="install" style="color: inherit; text-decoration: none;">
|
||||
<h2>Install</h2>
|
||||
</a>
|
||||
<p>Set up Rowy on your Google Cloud project with this one-click deploy button. Your data and cloud functions stay on your own Firestore/GCP.</p>
|
||||
<p><a href="https://deploy.rowy.app/"><img src="https://deploy.cloud.run/button.svg" alt="Run on Google Cloud"></a></p>
|
||||
<p>The one-click deploy makes the process of setting up easy with a step by step
|
||||
guide and ensures your project is setup correctly.</p>
|
||||
<p>It deploys <a href="https://github.com/rowyio/rowyrun">Rowy Run</a>, an open-source Cloud
|
||||
Run instance that operates exclusively on your GCP project. So we never have
|
||||
access to your service account or any of your data.</p>
|
||||
<p>Alternatively, you can manually install by
|
||||
<a href="https://docs.rowy.io/setup/install">following this guide</a>.</p>
|
||||
|
||||
<a href="#roadmap" id="roadmap" style="color: inherit; text-decoration: none;">
|
||||
<h2>Roadmap</h2>
|
||||
</a>
|
||||
<p><a href="https://demo.rowy.io/table/roadmap">View our roadmap</a> on Rowy - Upvote, downvote, share your thoughts!</p>
|
||||
<p>If you'd like to propose a feature, submit an issue <a href="https://github.com/rowyio/rowy/issues/new?assignees=&labels=&template=feature_request.md&title=">here</a>.</p>
|
||||
|
||||
<a href="#support-the-project" id="support-the-project" style="color: inherit; text-decoration: none;">
|
||||
<h2>Support the project</h2>
|
||||
</a>
|
||||
<ul>
|
||||
<li>Join a community of developers on <a href="https://discord.gg/fjBugmvzZP">Discord</a> and share your ideas/feedback 💬</li>
|
||||
<li>Follow us on <a href="https://twitter.com/rowyio">Twitter</a> and help <a href="https://twitter.com/intent/tweet?text=Check%20out%20@rowyio%20-%20It%27s%20like%20an%20open-source%20Airtable%20for%20your%20database,%20but%20with%20a%20built-in%20code%20editor%20for%20cloud%20functions%20to%20run%20on%20data%20CRUD!%0a%0aEsp%20if%20building%20on%20@googlecloud%20and%20@Firebase%20stack,%20it%20is%20the%20fastest%20way%20to%20build%20your%20product.%20Live%20demo:%20https://demo.rowy.io">spread the word</a> 🙏</li>
|
||||
<li>Give us a star to this Github repo ⭐️</li>
|
||||
<li>Submit a PR. Take a look at our <a href="https://github.com/rowyio/rowy/blob/main/CONTRIBUTING.md">contribution guide</a> and get started with <a href="https://github.com/rowyio/rowy/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22">good first issues</a>.</li>
|
||||
</ul>
|
||||
|
||||
<a href="#help" id="help" style="color: inherit; text-decoration: none;">
|
||||
<h2>Help</h2>
|
||||
</a>
|
||||
<ul>
|
||||
<li>Live chat support on <a href="https://discord.gg/fjBugmvzZP">Discord</a></li>
|
||||
<li><a href="mailto:hello@rowy.io">Email</a></li>
|
||||
</ul>
|
||||
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="modules/globalScope.html">global<wbr/>Scope</a></li><li class=" tsd-kind-module"><a href="modules/tableScope.html">table<wbr/>Scope</a></li></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-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-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></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/main.js"></script></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,5 +0,0 @@
|
||||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IAddColumnOptions | rowy</title><meta name="description" content="Documentation for rowy"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">rowy</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></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="../modules.html">rowy</a></li><li><a href="../modules/tableScope.html">tableScope</a></li><li><a href="tableScope.IAddColumnOptions.html">IAddColumnOptions</a></li></ul><h1>Interface IAddColumnOptions </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">IAddColumnOptions</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tableScope.IAddColumnOptions.html#config" class="tsd-kind-icon">config</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tableScope.IAddColumnOptions.html#index" class="tsd-kind-icon">index</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link">config<a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ColumnConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"index"</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rowyio/rowy/blob/1187e10a/src/atoms/tableScope/columnActions.ts#L13">src/atoms/tableScope/columnActions.ts:13</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Column config to add. <code>config.index</code> is ignored</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="index" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> index<a href="#index" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">index<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rowyio/rowy/blob/1187e10a/src/atoms/tableScope/columnActions.ts#L15">src/atoms/tableScope/columnActions.ts:15</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Index to add column at. If undefined, adds to end</p>
|
||||
</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="../modules/globalScope.html">global<wbr/>Scope</a></li><li class="current tsd-kind-module"><a href="../modules/tableScope.html">table<wbr/>Scope</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-module"><a href="tableScope.IAddColumnOptions.html" class="tsd-kind-icon">IAdd<wbr/>Column<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tableScope.IAddColumnOptions.html#config" class="tsd-kind-icon">config</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tableScope.IAddColumnOptions.html#index" class="tsd-kind-icon">index</a></li></ul></li></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-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-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></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/main.js"></script></body></html>
|
||||
@@ -1,7 +0,0 @@
|
||||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IAddRowOptions | rowy</title><meta name="description" content="Documentation for rowy"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">rowy</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></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="../modules.html">rowy</a></li><li><a href="../modules/tableScope.html">tableScope</a></li><li><a href="tableScope.IAddRowOptions.html">IAddRowOptions</a></li></ul><h1>Interface IAddRowOptions </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">IAddRowOptions</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tableScope.IAddRowOptions.html#ignoreRequiredFields" class="tsd-kind-icon">ignore<wbr/>Required<wbr/>Fields</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tableScope.IAddRowOptions.html#row" class="tsd-kind-icon">row</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tableScope.IAddRowOptions.html#setId" class="tsd-kind-icon">set<wbr/>Id</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ignoreRequiredFields" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ignore<wbr/>Required<wbr/>Fields<a href="#ignoreRequiredFields" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">ignore<wbr/>Required<wbr/>Fields<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rowyio/rowy/blob/1187e10a/src/atoms/tableScope/rowActions.ts#L37">src/atoms/tableScope/rowActions.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>If true, ignores checking required fields have values</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="row" class="tsd-anchor"></a><h3 class="tsd-anchor-link">row<a href="#row" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">row<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TableRow</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TableRow</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rowyio/rowy/blob/1187e10a/src/atoms/tableScope/rowActions.ts#L35">src/atoms/tableScope/rowActions.ts:35</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The row or array of rows to add</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="setId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> set<wbr/>Id<a href="#setId" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">set<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"random"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"decrement"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rowyio/rowy/blob/1187e10a/src/atoms/tableScope/rowActions.ts#L39">src/atoms/tableScope/rowActions.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Optionally overwite the IDs in the provided rows</p>
|
||||
</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="../modules/globalScope.html">global<wbr/>Scope</a></li><li class="current tsd-kind-module"><a href="../modules/tableScope.html">table<wbr/>Scope</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-module"><a href="tableScope.IAddRowOptions.html" class="tsd-kind-icon">IAdd<wbr/>Row<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tableScope.IAddRowOptions.html#ignoreRequiredFields" class="tsd-kind-icon">ignore<wbr/>Required<wbr/>Fields</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tableScope.IAddRowOptions.html#row" class="tsd-kind-icon">row</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tableScope.IAddRowOptions.html#setId" class="tsd-kind-icon">set<wbr/>Id</a></li></ul></li></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-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-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></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/main.js"></script></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,7 +0,0 @@
|
||||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IUpdateColumnOptions | rowy</title><meta name="description" content="Documentation for rowy"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">rowy</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></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="../modules.html">rowy</a></li><li><a href="../modules/tableScope.html">tableScope</a></li><li><a href="tableScope.IUpdateColumnOptions.html">IUpdateColumnOptions</a></li></ul><h1>Interface IUpdateColumnOptions </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">IUpdateColumnOptions</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tableScope.IUpdateColumnOptions.html#config" class="tsd-kind-icon">config</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tableScope.IUpdateColumnOptions.html#index" class="tsd-kind-icon">index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tableScope.IUpdateColumnOptions.html#key" class="tsd-kind-icon">key</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link">config<a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ColumnConfig</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rowyio/rowy/blob/1187e10a/src/atoms/tableScope/columnActions.ts#L51">src/atoms/tableScope/columnActions.ts:51</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Partial column config to add. <code>config.index</code> is ignored</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="index" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> index<a href="#index" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">index<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rowyio/rowy/blob/1187e10a/src/atoms/tableScope/columnActions.ts#L53">src/atoms/tableScope/columnActions.ts:53</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>If passed, reorders the column to the index</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="key" class="tsd-anchor"></a><h3 class="tsd-anchor-link">key<a href="#key" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rowyio/rowy/blob/1187e10a/src/atoms/tableScope/columnActions.ts#L49">src/atoms/tableScope/columnActions.ts:49</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Unique key of column to update</p>
|
||||
</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="../modules/globalScope.html">global<wbr/>Scope</a></li><li class="current tsd-kind-module"><a href="../modules/tableScope.html">table<wbr/>Scope</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-module"><a href="tableScope.IUpdateColumnOptions.html" class="tsd-kind-icon">IUpdate<wbr/>Column<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tableScope.IUpdateColumnOptions.html#config" class="tsd-kind-icon">config</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tableScope.IUpdateColumnOptions.html#index" class="tsd-kind-icon">index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tableScope.IUpdateColumnOptions.html#key" class="tsd-kind-icon">key</a></li></ul></li></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-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-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></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/main.js"></script></body></html>
|
||||
@@ -1,13 +0,0 @@
|
||||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IUpdateFieldOptions | rowy</title><meta name="description" content="Documentation for rowy"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">rowy</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></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="../modules.html">rowy</a></li><li><a href="../modules/tableScope.html">tableScope</a></li><li><a href="tableScope.IUpdateFieldOptions.html">IUpdateFieldOptions</a></li></ul><h1>Interface IUpdateFieldOptions </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">IUpdateFieldOptions</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tableScope.IUpdateFieldOptions.html#deleteField" class="tsd-kind-icon">delete<wbr/>Field</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tableScope.IUpdateFieldOptions.html#disableCheckEquality" class="tsd-kind-icon">disable<wbr/>Check<wbr/>Equality</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tableScope.IUpdateFieldOptions.html#fieldName" class="tsd-kind-icon">field<wbr/>Name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tableScope.IUpdateFieldOptions.html#ignoreRequiredFields" class="tsd-kind-icon">ignore<wbr/>Required<wbr/>Fields</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tableScope.IUpdateFieldOptions.html#path" class="tsd-kind-icon">path</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tableScope.IUpdateFieldOptions.html#value" class="tsd-kind-icon">value</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="deleteField" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> delete<wbr/>Field<a href="#deleteField" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">delete<wbr/>Field<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rowyio/rowy/blob/1187e10a/src/atoms/tableScope/rowActions.ts#L279">src/atoms/tableScope/rowActions.ts:279</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Optionally, delete the field with fieldName. Use dot notation to access nested fields.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="disableCheckEquality" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> disable<wbr/>Check<wbr/>Equality<a href="#disableCheckEquality" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">disable<wbr/>Check<wbr/>Equality<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rowyio/rowy/blob/1187e10a/src/atoms/tableScope/rowActions.ts#L283">src/atoms/tableScope/rowActions.ts:283</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Optionally, disable checking if the updated value is equal to the current value. By default, we skip the update if they’re equal.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="fieldName" class="tsd-anchor"></a><h3 class="tsd-anchor-link">field<wbr/>Name<a href="#fieldName" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">field<wbr/>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rowyio/rowy/blob/1187e10a/src/atoms/tableScope/rowActions.ts#L275">src/atoms/tableScope/rowActions.ts:275</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The field name to update. Use dot notation to access nested fields.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ignoreRequiredFields" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ignore<wbr/>Required<wbr/>Fields<a href="#ignoreRequiredFields" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">ignore<wbr/>Required<wbr/>Fields<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rowyio/rowy/blob/1187e10a/src/atoms/tableScope/rowActions.ts#L281">src/atoms/tableScope/rowActions.ts:281</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>If true, ignores checking required fields have values</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="path" class="tsd-anchor"></a><h3 class="tsd-anchor-link">path<a href="#path" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rowyio/rowy/blob/1187e10a/src/atoms/tableScope/rowActions.ts#L273">src/atoms/tableScope/rowActions.ts:273</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The path to the row to update</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link">value<a href="#value" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rowyio/rowy/blob/1187e10a/src/atoms/tableScope/rowActions.ts#L277">src/atoms/tableScope/rowActions.ts:277</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The value to write</p>
|
||||
</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="../modules/globalScope.html">global<wbr/>Scope</a></li><li class="current tsd-kind-module"><a href="../modules/tableScope.html">table<wbr/>Scope</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-module"><a href="tableScope.IUpdateFieldOptions.html" class="tsd-kind-icon">IUpdate<wbr/>Field<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tableScope.IUpdateFieldOptions.html#deleteField" class="tsd-kind-icon">delete<wbr/>Field</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tableScope.IUpdateFieldOptions.html#disableCheckEquality" class="tsd-kind-icon">disable<wbr/>Check<wbr/>Equality</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tableScope.IUpdateFieldOptions.html#fieldName" class="tsd-kind-icon">field<wbr/>Name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tableScope.IUpdateFieldOptions.html#ignoreRequiredFields" class="tsd-kind-icon">ignore<wbr/>Required<wbr/>Fields</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tableScope.IUpdateFieldOptions.html#path" class="tsd-kind-icon">path</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tableScope.IUpdateFieldOptions.html#value" class="tsd-kind-icon">value</a></li></ul></li></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-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-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></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/main.js"></script></body></html>
|
||||
@@ -1 +0,0 @@
|
||||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>rowy</title><meta name="description" content="Documentation for rowy"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">rowy</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></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"><h1> rowy </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Modules</h3><ul class="tsd-index-list"><li class="tsd-kind-module"><a href="modules/globalScope.html" class="tsd-kind-icon">global<wbr/>Scope</a></li><li class="tsd-kind-module"><a href="modules/tableScope.html" class="tsd-kind-icon">table<wbr/>Scope</a></li></ul></section></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="modules/globalScope.html">global<wbr/>Scope</a></li><li class=" tsd-kind-module"><a href="modules/tableScope.html">table<wbr/>Scope</a></li></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-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-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></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/main.js"></script></body></html>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user