Skip to content

Commit

Permalink
Formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
LukeTowers committed Jul 31, 2024
1 parent 7a7082e commit 17dd831
Show file tree
Hide file tree
Showing 16 changed files with 22 additions and 22 deletions.
2 changes: 1 addition & 1 deletion backend/forms.md
Original file line number Diff line number Diff line change
Expand Up @@ -679,7 +679,7 @@ public function myColorList($fieldName, $value, $formData)
}
```

If the `availableColors` field in not defined in the YAML file, the colorpicker uses a set of 20 default colors. You can also define a custom set of default colors to be used in all color pickers that do not have the `availableColors` field specified. This can be managed in the **Customize back-end** area of the Settings.
If the `availableColors` field in not defined in the YAML file, the colorpicker uses a set of 20 default colors. You can also define a custom set of default colors to be used in all color pickers that do not have the `availableColors` field specified. This can be managed in the **Customize backend** area of the Settings.

### Data table

Expand Down
2 changes: 1 addition & 1 deletion console/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Command | Description
[`mix:run`](../console/asset-compilation#run-a-package-script) | Runs a script within a given package.
**Scaffolding** |
[`create:command`](../console/scaffolding#create-a-console-command) | Create a Console Command class in a plugin.
[`create:component`](../console/scaffolding#create-a-component) | Create a front-end Component in a plugin.
[`create:component`](../console/scaffolding#create-a-component) | Create a frontend Component in a plugin.
[`create:controller`](../console/scaffolding#create-a-backend-controller) | Create a Controller in a plugin.
[`create:formwidget`](../console/scaffolding#create-a-form-widget) | Create a FormWidget in a plugin.
[`create:job`](../console/scaffolding#create-a-job) | Create a Job class in a plugin.
Expand Down
4 changes: 2 additions & 2 deletions ui/controls/chart.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ The next example shows a bar chart markup. The **wrap-legend** class is optional

![image](https://raw.githubusercontent.com/wintercms/docs/develop/images/bar-chart.png)

# Example
## Example

```html
<div
Expand Down Expand Up @@ -162,7 +162,7 @@ The next example shows a bar chart markup. The **wrap-legend** class is optional

A list of statuses and values

# Example
## Example

```html
<div class="control-status-list">
Expand Down
2 changes: 1 addition & 1 deletion ui/controls/datepicker.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Date Pickers
# Date Picker

Renders a date picker, time picker, or both. The input associated to each control acts as a facade, the final value is stored in an underlying hidden input, called a data locker.

Expand Down
2 changes: 1 addition & 1 deletion ui/controls/filter.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

- Popover

# Example
## Example

```html
<div id="filterExample" class="control-filter" data-control="filterwidget">
Expand Down
2 changes: 1 addition & 1 deletion ui/controls/flashmessage.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Flash message
## Flash Message

Displays a floating flash message on the screen.

Expand Down
8 changes: 4 additions & 4 deletions ui/controls/inspector.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Inspector control
# Inspector

Inspector is a visual configuration tool that is used in several places of Winter back-end. The most known usage of Inspector is the CMS components configuration feature, but Inspector is not limited with the CMS. In fact, it's a universal tool that can be used with any element on a back-end page.
Inspector is a visual configuration tool that is used in several places of Winter backend. The most known usage of Inspector is the CMS components configuration feature, but Inspector is not limited to the CMS. In fact, it's a universal tool that can be used with any element on a backend page.

The Inspector loads the configuration schema from an inspectable element, builds the user interface, and writes values entered by users back to the inspectable element. The first version of Inspector was supporting only a few scalar value types - strings and Booleans, without an option to edit any complex data.

The current version of Inspector allows to edit any imaginable data structures, including cases where users create enumerable data elements right in the Inspector interface.

This section describes the client-side Inspector API without going into details about the back-end usage of the data Inspector generates. Inspector accepts the configuration schema in JSON format and generates values in JSON format as well. Providing the configuration and interpreting the generated values is up to developers. For example, the CMS module uses information returned from component's defineProperties() method to generate the configuration JSON string and converts JSON values generated by Inspector to the components configuration in CMS templates. In this document we are focusing only on the JSON format.
This section describes the client-side Inspector API without going into details about the backend usage of the data Inspector generates. Inspector accepts the configuration schema in JSON format and generates values in JSON format as well. Providing the configuration and interpreting the generated values is up to developers. For example, the CMS module uses information returned from component's defineProperties() method to generate the configuration JSON string and converts JSON values generated by Inspector to the components configuration in CMS templates. In this document we are focusing only on the JSON format.

## Configuring inspectable elements

Expand Down Expand Up @@ -47,7 +47,7 @@ There are several optional data attributes and features that could be defined in

In case if the `data-inspector-config` attribute is missing in the inspectable element Inspector tries to load its configuration from the server. An important note - there should be a FORM element wrapping inspectable elements in order to use any dynamic features of Inspector.

The AJAX request used for loading the configuration from the server is named `onGetInspectorConfiguration`. The handler should be defined in the back-end controller and should return an array containing the Inspector configuration (in the PHP equivalent of the JSON configuration structure described later in this section), inspector title and description. Example of a server-side AJAX dynamic configuration request handler:
The AJAX request used for loading the configuration from the server is named `onGetInspectorConfiguration`. The handler should be defined in the backend controller and should return an array containing the Inspector configuration (in the PHP equivalent of the JSON configuration structure described later in this section), inspector title and description. Example of a server-side AJAX dynamic configuration request handler:

```php
public function onGetInspectorConfiguration()
Expand Down
4 changes: 2 additions & 2 deletions ui/controls/loader.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Loading indicators
# Loading Indicators

## Container Loading Indicator

Expand Down Expand Up @@ -108,7 +108,7 @@ You may add some optional text:
</div>
```

# Example
## Example

```html
<div class="loading-indicator-container">
Expand Down
4 changes: 2 additions & 2 deletions ui/controls/tab.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Tab control
# Tabs

This plugin is a wrapper for the Twitter Bootstrap Tab component. It provides the following features:

Expand Down Expand Up @@ -104,7 +104,7 @@ These modifiers can be added in addition to the `control-tabs` class:
</div>
```

> **NOTE**: Primary tabs in the Winter back-end are inset by default and you should use `.tabs-no-inset` to disable this.
> **NOTE**: Primary tabs in the Winter backend are inset by default and you should use `.tabs-no-inset` to disable this.
### Secondary tabs

Expand Down
2 changes: 1 addition & 1 deletion ui/controls/tooltip.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Tooltips can be automatically created when the mouse enters an element using the
</a>
```

# Example
## Example

```html
<div class="tooltip fade top in">
Expand Down
2 changes: 1 addition & 1 deletion ui/script/foundation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The foundation libraries are the core base of all scripts and controls. The goal
- Unbind all event handlers.
- Write high-performance code (in cases when it's needed).

That's especially important on pages where users spend much time interacting with the page, like the CMS and Pages sections, but all back-end controls should follow these rules, because we never know when they are used.
That's especially important on pages where users spend much time interacting with the page, like the CMS and Pages sections, but all backend controls should follow these rules, because we never know when they are used.

## Why it's important to release the memory, DOM references and event handlers

Expand Down
2 changes: 1 addition & 1 deletion ui/script/input-hotkey.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Allows keyboard shortcuts (hotkeys) to be bound to an element's click event.

# Example
## Example

<button
class="btn btn-default"
Expand Down
2 changes: 1 addition & 1 deletion ui/script/input-preset.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Scripts that manage user input events.

# Example
## Example

<input type="text" id="presetExample1" placeholder="Type something" />
<input type="text"
Expand Down
2 changes: 1 addition & 1 deletion ui/style/breadcrumb.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Display a breadcrumb on the page.

# Example
## Example

<div style="padding: 20px">
<div class="control-breadcrumb">
Expand Down
2 changes: 1 addition & 1 deletion ui/style/progressbar.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Progress bar

# Example
## Example

<div class="progress">
<div class="progress-bar" role="progressbar" aria-valuenow="60" aria-valuemin="0" aria-valuemax="100" style="width: 60%;">
Expand Down
2 changes: 1 addition & 1 deletion ui/toc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ sections:
controls/inspector: "Inspector"
controls/flashmessage: "Flash Message"
controls/filter: "Filter"
controls/loader: "Loader"
controls/loader: "Loading Indicator"
controls/tooltip: "Tooltip"
controls/toolbar: "Toolbar"
controls/popover: "Popover"
Expand Down

0 comments on commit 17dd831

Please sign in to comment.