From 225f69cdb3fed7354c0b19151941cf3e7023b1e9 Mon Sep 17 00:00:00 2001 From: wozboz Date: Sun, 20 Aug 2023 14:22:23 +0200 Subject: [PATCH 1/2] :memo: corrected some typos in the docs --- docs/alternate-views.md | 2 +- docs/development-guides.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/alternate-views.md b/docs/alternate-views.md index 57f756c9..d43215d3 100644 --- a/docs/alternate-views.md +++ b/docs/alternate-views.md @@ -47,7 +47,7 @@ Dashy supports several different ways to launch your apps. The primary opening m - `sametab` - The app will be launched in the current tab - `newtab` - The app will be launched in a new tab -- `top` - Opens in the top-most browsing context, useful if your accessing Dashy through an iframe +- `top` - Opens in the top-most browsing context, useful if you're accessing Dashy through an iframe - `modal` - Launch app in a resizable/ movable popup modal on the current page - `workspace` - Changes to Workspace view, and launches app diff --git a/docs/development-guides.md b/docs/development-guides.md index 0d629412..492a416a 100644 --- a/docs/development-guides.md +++ b/docs/development-guides.md @@ -313,7 +313,7 @@ export default { All widgets extend from the [Widget](https://github.com/Lissy93/dashy/blob/master/src/mixins/WidgetMixin.js) mixin. This provides some basic functionality that is shared by all widgets. The mixin includes the following `options`, `startLoading()`, `finishLoading()`, `error()` and `update()`. - **Getting user options: `options`** - - Any user-specific config can be accessed with `this.options.something` (where something is the data key your accessing) + - Any user-specific config can be accessed with `this.options.something` (where something is the data key you're accessing) - **Loading state: `startLoading()` and `finishLoading()`** - You can show the loader with `this.startLoading()`, then when your data request completes, hide it again with `this.finishLoading()` - **Error handling: `error()`** @@ -341,7 +341,7 @@ computed: { #### **Adding an API Endpoint** -If your widget makes a data request, then add the URL for the API under point to the `widgetApiEndpoints` array in [`defaults.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/defaults.js#L207) +If your widget makes a data request, then add the URL for the API endpoint to the `widgetApiEndpoints` array in [`defaults.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/defaults.js#L207) ```javascript widgetApiEndpoints: { @@ -410,7 +410,7 @@ Now that the results are in the correct format, and stored as data variables, we #### **Styling** -Styles can be written your your widget within the `