Skip to content

Commit

Permalink
upd: docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Tardo committed Jan 24, 2024
1 parent fb8e622 commit 438ed96
Show file tree
Hide file tree
Showing 17 changed files with 26 additions and 27 deletions.
2 changes: 1 addition & 1 deletion docs/mirlo/0.4.0/Component.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/mirlo/0.4.0/LocalStorageService.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/mirlo/0.4.0/RequestsService.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/mirlo/0.4.0/Service.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/mirlo/0.4.0/SessionStorageService.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/mirlo/0.4.0/base_app.mjs.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/mirlo/0.4.0/base_component.mjs.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/mirlo/0.4.0/base_service.mjs.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/mirlo/0.4.0/base_state.mjs.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/mirlo/0.4.0/data/search.json

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/mirlo/0.4.0/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/mirlo/0.4.0/module-mirlo.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/mirlo/0.4.0/services_requests.mjs.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/mirlo/0.4.0/services_storage.mjs.html

Large diffs are not rendered by default.

8 changes: 3 additions & 5 deletions docs/mirlo/0.4.0/tutorial-Components.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@
}
}
</code></pre><p>Example:</p><pre class="prettyprint source lang-javascript"><code>Component.useEvents({
&quot;.tab&quot;: {
'.tab': {
click: this.onClickTab,
}
},
});
</code></pre></li><li><p><code>useFetchData()</code> -&gt; Configure component prefetched network data.</p><p>The function receives an object with the following scheme:</p><pre class="prettyprint source"><code>{
&lt;CUSTOM NAME>: {
Expand All @@ -60,9 +60,7 @@
},
});
</code></pre></li><li><p><code>useStyles()</code> -&gt; Configure component styles.</p><p>The function receives an array of strings with the location of the css resources:</p><pre class="prettyprint source"><code>[&lt;Strings>]
</code></pre><p>Example:</p><pre class="prettyprint source lang-javascript"><code>Component.useStyles([
'/static/css/mycomponent.css',
]);
</code></pre><p>Example:</p><pre class="prettyprint source lang-javascript"><code>Component.useStyles(['/static/css/mycomponent.css']);
</code></pre></li><li><p><code>enableAnimation()</code> -&gt; Enable component animation mode.</p></li><li><p><code>disableShadow()</code> -&gt; Disable Shadow DOM usage.</p></li></ul><h3 id="create-an-animated-component">Create an animated component</h3><pre class="prettyprint source lang-javascript"><code>import {Component, registerComponent} from 'mirlo';

class DemoAnimated extends Component {
Expand Down
1 change: 1 addition & 0 deletions jsdoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
"recurse": true,
"verbose": true,
"template": "node_modules/clean-jsdoc-theme",
"tutorials": "tutorials/",
"theme_opts": {
"default_theme": "dark"
}
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
"watch": "rollup -c -w",
"build": "rollup -c",
"test": "npm run build && node --experimental-vm-modules node_modules/.bin/jest",
"generate-docs": "jsdoc -u ./tutorials -c jsdoc.json"
"generate-docs": "jsdoc -c jsdoc.json"
},
"devDependencies": {
"@rollup/plugin-alias": "^5.0.1",
Expand Down

0 comments on commit 438ed96

Please sign in to comment.