Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs/add missing typedoc plugins #252

Merged
merged 5 commits into from
Aug 20, 2024
Merged

Docs/add missing typedoc plugins #252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d4c14e0
docs: ✏️ Use uniform layout for name
phun-ky Aug 19, 2024
e3ac6ed
Merge branch 'main' of github.com:phun-ky/speccer
phun-ky Aug 20, 2024
0f5b76e
docs: ✏️ Add missing typedoc plugin for mdn links
phun-ky Aug 20, 2024
34cc5e9
docs: ✏️ Regenerate API documentation
phun-ky Aug 20, 2024
29e8026
docs: ✏️ Give correct order of `curly` feature in examples
phun-ky Aug 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to @phun-ky/speccer
# Contributing to **SPECCER**

First off, thanks for taking the time to contribute! ❤️

Expand All @@ -13,7 +13,7 @@ All types of contributions are encouraged and valued. See the [Table of Contents

## Table of Contents

- [Contributing to @phun-ky/speccer](#contributing-to-phun-kyspeccer)
- [Contributing to **SPECCER**](#contributing-to-speccer)
- [Table of Contents](#table-of-contents)
- [Code of Conduct](#code-of-conduct)
- [I Have a Question](#i-have-a-question)
Expand All @@ -29,7 +29,7 @@ All types of contributions are encouraged and valued. See the [Table of Contents
## Code of Conduct

This project and everyone participating in it is governed by the
[@phun-ky/speccer Code of Conduct](https://github.com/phun-ky/speccer/blob/master/CODE_OF_CONDUCT.md).
[**SPECCER** Code of Conduct](https://github.com/phun-ky/speccer/blob/master/CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code. Please report unacceptable behavior
to <code-of-conduct@phun-ky.net>.

Expand Down Expand Up @@ -108,7 +108,7 @@ Once it's filed:

### Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for @phun-ky/speccer, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
This section guides you through submitting an enhancement suggestion for **SPECCER**, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

#### Before Submitting an Enhancement

Expand All @@ -125,7 +125,7 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/phun-k
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. <!-- this should only be included if the project has a GUI -->
- **Explain why this enhancement would be useful** to most @phun-ky/speccer users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
- **Explain why this enhancement would be useful** to most **SPECCER** users. You may also want to point out the other projects that solved it better and which could serve as inspiration.

<!-- You might want to create an issue template for enhancement suggestions that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->

Expand Down
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ speccer();

#### Lazy loading

If you're importing speccer instead of with a script tag, [you can use the following approach](https://codepen.io/phun-ky/pen/VwRRLyY) to apply lazy loading:
If you're importing **SPECCER** instead of with a script tag, [you can use the following approach](https://codepen.io/phun-ky/pen/VwRRLyY) to apply lazy loading:

```javascript
import { pin } from "https://esm.sh/@phun-ky/speccer";
Expand Down Expand Up @@ -139,7 +139,7 @@ And then follow the steps below to display the specifications you want :)

#### Advanced usage

If you want to control speccer a bit more, you have some options. Apply one of these attributes to the script element for different types of initialization:
If you want to control **SPECCER** a bit more, you have some options. Apply one of these attributes to the script element for different types of initialization:

```html
<script src="../speccer.js" data-<manual|instant|dom|lazy></script>
Expand Down Expand Up @@ -245,7 +245,7 @@ In your component examples, use the following attribute. Remember to use the `da
```html
<div data-speccer="pin-area">
<div
data-speccer="pin [bracket|enclose][curly] [left|right|top|bottom]"
data-speccer="pin [bracket [curly] |enclose] [left|right|top|bottom]"
class="..."
></div>
</div>
Expand Down Expand Up @@ -440,7 +440,7 @@ In your component examples, use the following attribute.

### A11y notation

With speccer, you can also display accessibility notation, like [Accessibility Bluelines](https://dribbble.com/shots/6269661-Accessibility-Bluelines?utm_source=Clipboard_Shot&utm_campaign=jeremyelder&utm_content=Accessibility%20Bluelines&utm_medium=Social_Share&utm_source=Clipboard_Shot&utm_campaign=jeremyelder&utm_content=Accessibility%20Bluelines&utm_medium=Social_Share):
With **SPECCER**, you can also display accessibility notation, like [Accessibility Bluelines](https://dribbble.com/shots/6269661-Accessibility-Bluelines?utm_source=Clipboard_Shot&utm_campaign=jeremyelder&utm_content=Accessibility%20Bluelines&utm_medium=Social_Share&utm_source=Clipboard_Shot&utm_campaign=jeremyelder&utm_content=Accessibility%20Bluelines&utm_medium=Social_Share):

Prior art: [Jeremy Elder](https://twitter.com/JeremyElder)

Expand Down
2 changes: 1 addition & 1 deletion api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

---

> Last updated 2024-08-20T06:28:48.100Z
> Last updated 2024-08-20T06:35:08.838Z

## Modules

Expand Down
2 changes: 1 addition & 1 deletion api/config/browser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# config/browser

> Last updated 2024-08-20T06:28:48.103Z
> Last updated 2024-08-20T06:35:08.839Z

Contains the helper functions to activate SPECCER via a script tag, based on attributes:

Expand Down
26 changes: 13 additions & 13 deletions api/features/a11y.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# features/a11y

> Last updated 2024-08-20T06:28:48.106Z
> Last updated 2024-08-20T06:35:08.842Z

## Functions

Expand All @@ -28,7 +28,7 @@ Creates an HTML element based on the specified type. \*

#### Returns

`HTMLElement`
[`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement)

The created HTML element.

Expand Down Expand Up @@ -59,15 +59,15 @@ Adds an accessibility element to the document body based on the target element a

#### Parameters

| Parameter | Type | Description |
| ---------- | ------------- | --------------------------------------------------------- |
| `targetEl` | `HTMLElement` | Target HTML element. |
| `content`? | `unknown` | Content to be added to the accessibility element. |
| `type`? | `string` | Type of accessibility element ('tabstops' or 'landmark'). |
| Parameter | Type | Description |
| ---------- | ----------------------------------------------------------------------- | --------------------------------------------------------- |
| `targetEl` | [`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement) | Target HTML element. |
| `content`? | `unknown` | Content to be added to the accessibility element. |
| `type`? | `string` | Type of accessibility element ('tabstops' or 'landmark'). |

#### Returns

`Promise`\<`void`>
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`>

A Promise resolving when the operation is complete.

Expand Down Expand Up @@ -123,14 +123,14 @@ Adds a shortcut element to the document body based on the provided HTML element

#### Parameters

| Parameter | Type | Description |
| ---------------- | ------------- | -------------------------------- |
| `el` | `HTMLElement` | Target HTML element. |
| `shortcutString` | `string` | Shortcut string to be displayed. |
| Parameter | Type | Description |
| ---------------- | ----------------------------------------------------------------------- | -------------------------------- |
| `el` | [`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement) | Target HTML element. |
| `shortcutString` | `string` | Shortcut string to be displayed. |

#### Returns

`Promise`\<`void`>
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`>

A Promise resolving when the operation is complete.

Expand Down
2 changes: 1 addition & 1 deletion api/features/a11y/constants.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# features/a11y/constants

> Last updated 2024-08-20T06:28:48.108Z
> Last updated 2024-08-20T06:35:08.843Z

## Variables

Expand Down
14 changes: 7 additions & 7 deletions api/features/a11y/utils/styles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# features/a11y/utils/styles

> Last updated 2024-08-20T06:28:48.110Z
> Last updated 2024-08-20T06:35:08.844Z

## Functions

Expand All @@ -24,15 +24,15 @@ Calculates and returns the styles for an accessibility element based on its type

#### Parameters

| Parameter | Type | Description |
| --------------- | ------------- | --------------------------------------------------------------------------------------------- |
| `type` | `string` | Type of the accessibility element ('tabstops', 'landmark', 'region', 'shortcut', or default). |
| `targetElement` | `HTMLElement` | Target HTML element. |
| `a11yElement` | `HTMLElement` | Accessibility HTML element to be styled. |
| Parameter | Type | Description |
| --------------- | ----------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `type` | `string` | Type of the accessibility element ('tabstops', 'landmark', 'region', 'shortcut', or default). |
| `targetElement` | [`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement) | Target HTML element. |
| `a11yElement` | [`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement) | Accessibility HTML element to be styled. |

#### Returns

`Promise`\<[`SpeccerStylesReturnType`](../../../types/styles.md#speccerstylesreturntype)>
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`SpeccerStylesReturnType`](../../../types/styles.md#speccerstylesreturntype)>

A Promise resolving with the calculated styles.

Expand Down
20 changes: 10 additions & 10 deletions api/features/grid.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# features/grid

> Last updated 2024-08-20T06:28:48.110Z
> Last updated 2024-08-20T06:35:08.844Z

## Functions

Expand All @@ -20,14 +20,14 @@ Creates a visual grid overlay for a given target element.

#### Parameters

| Parameter | Type | Description |
| --------------- | --------------------- | -------------------------------------------------- |
| `targetElement` | `HTMLElement` | The target element to create the grid overlay for. |
| `styles` | `CSSStyleDeclaration` | The computed styles of the target element. |
| Parameter | Type | Description |
| --------------- | --------------------------------------------------------------------------------------- | -------------------------------------------------- |
| `targetElement` | [`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement) | The target element to create the grid overlay for. |
| `styles` | [`CSSStyleDeclaration`](https://developer.mozilla.org/docs/Web/API/CSSStyleDeclaration) | The computed styles of the target element. |

#### Returns

`Promise`\<`HTMLDivElement`>
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)>

The created grid container element.

Expand Down Expand Up @@ -62,13 +62,13 @@ Adds a visual grid overlay to the target element if it has the appropriate data

#### Parameters

| Parameter | Type | Description |
| --------------- | ------------- | ---------------------------------------------- |
| `targetElement` | `HTMLElement` | The target element to add the grid overlay to. |
| Parameter | Type | Description |
| --------------- | ----------------------------------------------------------------------- | ---------------------------------------------- |
| `targetElement` | [`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement) | The target element to add the grid overlay to. |

#### Returns

`Promise`\<`void`>
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`>

A promise that resolves once the overlay has been added.

Expand Down
12 changes: 6 additions & 6 deletions api/features/mark.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# features/mark

> Last updated 2024-08-20T06:28:48.111Z
> Last updated 2024-08-20T06:35:08.845Z

## Functions

Expand All @@ -26,7 +26,7 @@ Create a marker element with an optional element type.

#### Returns

`HTMLElement`
[`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement)

- The created marker element.

Expand Down Expand Up @@ -55,13 +55,13 @@ Create a marker element and add it to the body with styles matching a specified

#### Parameters

| Parameter | Type | Description |
| --------------- | ------------- | ---------------------------------------- |
| `targetElement` | `HTMLElement` | The target element to match styles with. |
| Parameter | Type | Description |
| --------------- | ----------------------------------------------------------------------- | ---------------------------------------- |
| `targetElement` | [`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement) | The target element to match styles with. |

#### Returns

`Promise`\<`void`>
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`>

- A promise that resolves after creating and styling the marker element.

Expand Down
12 changes: 6 additions & 6 deletions api/features/measure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# features/measure

> Last updated 2024-08-20T06:28:48.112Z
> Last updated 2024-08-20T06:35:08.845Z

## Functions

Expand All @@ -28,7 +28,7 @@ Create a measurement element with optional text, area, and element type.

#### Returns

`HTMLElement`
[`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement)

- The created measurement element.

Expand Down Expand Up @@ -57,13 +57,13 @@ Create a measurement element and add it to the body with styles matching a speci

#### Parameters

| Parameter | Type | Description |
| --------------- | ------------- | ---------------------------------------- |
| `targetElement` | `HTMLElement` | The target element to match styles with. |
| Parameter | Type | Description |
| --------------- | ----------------------------------------------------------------------- | ---------------------------------------- |
| `targetElement` | [`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement) | The target element to match styles with. |

#### Returns

`Promise`\<`void`>
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`>

- A promise that resolves after creating and styling the measurement element.

Expand Down
12 changes: 6 additions & 6 deletions api/features/pin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# features/pin

> Last updated 2024-08-20T06:28:48.112Z
> Last updated 2024-08-20T06:35:08.846Z

This feature highlights the anatomy of an element.

Expand All @@ -28,7 +28,7 @@ In your component examples, use the following attribute. Remember to use the `da
```html
<div data-speccer="pin-area">
<div
data-speccer="pin [bracket|enclose][curly] [left|right|top|bottom]"
data-speccer="pin [bracket [curly] |enclose] [left|right|top|bottom]"
class="..."
></div>
</div>
Expand Down Expand Up @@ -56,13 +56,13 @@ Create pinned elements based on the section element and its data-speccer attribu

#### Parameters

| Parameter | Type | Description |
| ---------------- | ------------- | ----------------------------------------------- |
| `sectionElement` | `HTMLElement` | The section element containing pinned elements. |
| Parameter | Type | Description |
| ---------------- | ----------------------------------------------------------------------- | ----------------------------------------------- |
| `sectionElement` | [`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement) | The section element containing pinned elements. |

#### Returns

`Promise`\<`void`>
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`>

- A promise that resolves after creating pinned elements.

Expand Down
4 changes: 2 additions & 2 deletions api/features/pin/utils/create-pin-element.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# features/pin/utils/create-pin-element

> Last updated 2024-08-20T06:28:48.113Z
> Last updated 2024-08-20T06:35:08.846Z

## Functions

Expand All @@ -29,7 +29,7 @@ Create a pin element with optional text content, area description, and element t

#### Returns

`HTMLElement`
[`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement)

- The created pin element.

Expand Down
2 changes: 1 addition & 1 deletion api/features/pin/utils/get-character-to-use.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# features/pin/utils/get-character-to-use

> Last updated 2024-08-20T06:28:48.114Z
> Last updated 2024-08-20T06:35:08.847Z

## Functions

Expand Down
Loading
Loading