Skip to content

Commit

Permalink
🔀 Merge pull request #1293 from wozboz/master
Browse files Browse the repository at this point in the history
Fixed typos in documentation
  • Loading branch information
Lissy93 committed Aug 21, 2023
2 parents 7669629 + a75afce commit 3e1e42d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/alternate-views.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 4 additions & 4 deletions docs/development-guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -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()`**
Expand Down Expand Up @@ -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: {
Expand Down Expand Up @@ -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 `<style>` block.
Styles can be written for your widget within the `<style>` block.

There are several color variables used by widgets, which extend from the base palette. Using these enables users to override colors to theme their dashboard, if they wish. The variables are: `--widget-text-color`, `--widget-background-color` and `--widget-accent-color`

Expand Down Expand Up @@ -439,7 +439,7 @@ Here, the `example-widget` property name will be used to identify the widget whe

### Step 4 - Docs

Finally, add some documentation for your widget in the [Widget Docs](https://github.com/Lissy93/dashy/blob/master/docs/widgets.md), so that others know hoe to use it. Include the following information: Title, short description, screenshot, config options and some example YAML.
Finally, add some documentation for your widget in the [Widget Docs](https://github.com/Lissy93/dashy/blob/master/docs/widgets.md), so that others know how to use it. Include the following information: Title, short description, screenshot, config options and some example YAML.

**Summary**: For a complete example of everything discussed here, see: [`3da76ce`](https://github.com/Lissy93/dashy/commit/3da76ce2999f57f76a97454c0276301e39957b8e)

Expand Down

0 comments on commit 3e1e42d

Please sign in to comment.