10000 docs: improve documenatation · coreui/coreui-pro@b74ff6a · GitHub
[go: up one dir, main page]
Skip to content

Commit b74ff6a

Browse files
mrholekmrholek
committed
docs: improve documenatation
1 parent 7d12b88 commit b74ff6a

File tree

9 files changed

+179
-161
lines changed

9 files changed

+179
-161
lines changed

‎docs/content/components/alerts.md

Lines changed: 72 additions & 52 deletions
Large diffs are not rendered by default.

‎docs/content/components/tooltips.md

Lines changed: 98 additions & 100 deletions
Large diffs are not rendered by default.

‎docs/layouts/partials/callouts/danger-async-methods.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#### Asynchronous methods and transitions
22

3-
All API methods are **asynchronous** and start a **transition**. They return to the caller as soon as the transition is started but **before it ends**. In addition, a method call on a **transitioning component will be ignored**.
3+
All our API methods are **asynchronous** and initiate a **transition**. They return to the caller as soon as the transition begins but **before it concludes**. Furthermore, a method call on a **transitioning component will be ignored**.
44

5-
[See our JavaScript documentation for more information](/getting-started/javascript/#asynchronous-functions-and-transitions).
5+
[Refer to our JavaScript documentation for further details](/getting-started/javascript/#asynchronous-functions-and-transitions).

‎docs/layouts/partials/callouts/info-prefersreducedmotion.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
The animation effect of this component is dependent on the `prefers-reduced-motion` media query. See the [reduced motion section of our accessibility documentation](/getting-started/accessibility/#reduced-motion).
1+
This component's animation effect relies on the `prefers-reduced-motion` media query. For more information, refer to the [reduced motion section of our accessibility documentation](/getting-started/accessibility/#reduced-motion).

‎docs/layouts/partials/callouts/info-sanitizer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
By default, this component uses the built-in content sanitizer, which strips out any HTML elements that are not explicitly allowed. See the [sanitizer section in our JavaScript documentation](/getting-started/javascript/#sanitizer) for more details.
1+
By default, this component utilizes the built-in content sanitizer, which removes any HTML elements that are not explicitly allowed. Refer to the [sanitizer section in our JavaScript documentation](/getting-started/javascript/#sanitizer) for more details.

‎docs/layouts/partials/callouts/warning-color-assistive-technologies.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
##### Conveying meaning to assistive technologies
22

3-
Using color to add meaning only provides a visual indication, which will not be conveyed to users of assistive technologies – such as screen readers. Ensure that information denoted by the color is either obvious from the content itself (e.g. the visible text), or is included through alternative means, such as additional text hidden with the `.visually-hidden` class.
3+
Relying on color to convey meaning creates a visual cue that assistive technologies, like screen readers, cannot perceive. It's essential that any information represented by color is either apparent from the content itself (e.g., the visible text) or supplemented by alternative methods, such as extra text using the `.visually-hidden` class.

‎docs/layouts/partials/callouts/warning-data-bs-title-vs-title.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Feel free to use either `title` or `data-coreui-title` in your HTML. When `title` is used, Popper will replace it automatically with `data-coreui-title` when the element is rendered.
1+
You can choose to use either `title` or `data-coreui-title` in your HTML. If you opt for `title,` Popper will automatically change it to `data-coreui-title` upon rendering the element.

‎docs/layouts/partials/js-data-attributes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
As options can be passed via data attributes or JavaScript, you can append an option name to `data-coreui-`, as in `data-coreui-animation="{value}"`. Make sure to change the case type of the option name from "_camelCase_" to "_kebab-case_" when passing the options via data attributes. For example, use `data-coreui-custom-class="beautifier"` instead of `data-coreui-customClass="beautifier"`.
1+
Options can be passed using data attributes or JavaScript. To do this, append an option name to `data-coreui-`, such as `data-coreui-animation="{value}"`. Remember to convert the case of the option name from "_camelCase_" to "_kebab-case_" when using data attributes. For instance, you should write `data-coreui-custom-class="beautifier"` rather than `data-coreui-customClass="beautifier"`.
22

3-
As of CoreUI 4.2.6, all components support an **experimental** reserved data attribute `data-coreui-config` that can house simple component configuration as a JSON string. When an element has `data-coreui-config='{"delay":0, "title":123}'` and `data-coreui-title="456"` attributes, the final `title` value will be `456` and the separate data attributes will override values given on `data-coreui-config`. In addition, existing data attributes are able to house JSON values like `data-coreui-delay='{"show":0,"hide":150}'`.
3+
Starting with CoreUI 4.2.6, all components support an **experimental** reserved data attribute named `data-coreui-config`, which can contain simple component configurations as a JSON string. If an element has attributes `data-coreui-config='{"delay":50, "title":689}'` and `data-coreui-title="Custom Title"`, then the final value for `title` will be `Custom Title`, as the standard data attributes will take precedence over values specified in `data-coreui-config`. Moreover, existing data attributes can also hold JSON values like `data-coreui-delay='{"show":50, "hide":250}'`.

‎docs/layouts/shortcodes/markdown.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{{- .Inner | markdownify -}}
1+
{{ .Inner | htmlUnescape | markdownify }}

0 commit comments

Comments
 (0)
0