Skip to content

Commit

Permalink
chore: 🤖 Regenerate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@phun-ky
phun-ky committed Aug 23, 2024
1 parent dfeff17 commit fb5ec15
Show file tree
Hide file tree
Showing 58 changed files with 85 additions and 83 deletions.
2 changes: 1 addition & 1 deletion api/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

---

> Last updated 2024-08-22T06:56:09.088Z
> Last updated 2024-08-23T11:58:26.652Z
## Modules

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

# config/browser

> Last updated 2024-08-22T06:56:09.090Z
> Last updated 2024-08-23T11:58:26.653Z
Contains the helper functions to activate SPECCER via a script tag, based on attributes:

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

# features/a11y

> Last updated 2024-08-22T06:56:09.093Z
> Last updated 2024-08-23T11:58:26.655Z
## Functions

Expand Down
4 changes: 2 additions & 2 deletions api/features/a11y/constants.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@

# features/a11y/constants

> Last updated 2024-08-22T06:56:09.095Z
> Last updated 2024-08-23T11:58:26.656Z
## Variables

### SPECCER_LANDMARK_ELEMENTS_SELECTOR

```ts
const SPECCER_LANDMARK_ELEMENTS_SELECTOR: '\nheader, footer, section, main, nav, aside, [role="section"], [role="banner"],\n[role="complementary"], [role="contentinfo"], [role="form"], [role="main"],\n[role="navigation"], [role="region"], [role="search"]\n';
const SPECCER_LANDMARK_ELEMENTS_SELECTOR: '\nheader, footer, section, form, main, nav, aside, [role="section"], [role="banner"],\n[role="complementary"], [role="contentinfo"], [role="form"], [role="main"],\n[role="navigation"], [role="region"], [role="search"]\n';
```

Selector string for landmark elements.
Expand Down
2 changes: 1 addition & 1 deletion api/features/a11y/utils/styles.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# features/a11y/utils/styles

> Last updated 2024-08-22T06:56:09.097Z
> Last updated 2024-08-23T11:58:26.657Z
## Functions

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

# features/grid

> Last updated 2024-08-22T06:56:09.097Z
> Last updated 2024-08-23T11:58:26.658Z
## Functions

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

# features/mark

> Last updated 2024-08-22T06:56:09.098Z
> Last updated 2024-08-23T11:58:26.658Z
## Functions

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

# features/measure

> Last updated 2024-08-22T06:56:09.099Z
> Last updated 2024-08-23T11:58:26.659Z
## Functions

Expand Down Expand Up @@ -41,7 +41,7 @@ document.body.appendChild(measurement);

#### Defined in

[features/measure/index.ts:29](https://github.com/phun-ky/speccer/blob/main/src/features/measure/index.ts#L29)
[features/measure/index.ts:30](https://github.com/phun-ky/speccer/blob/main/src/features/measure/index.ts#L30)

---

Expand All @@ -51,7 +51,7 @@ document.body.appendChild(measurement);
function element(targetElement): Promise<void>;
```

Create a measurement element and add it to the body with styles matching a specified target element.
Create a measurement element and add it to the body with styles matching a specified target element based on the attribute values from `data-speccer`.

![measure](https://github.com/phun-ky/speccer/blob/main/public/measure.png?raw=true)

Expand All @@ -76,7 +76,7 @@ element(targetElement);

#### Defined in

[features/measure/index.ts:58](https://github.com/phun-ky/speccer/blob/main/src/features/measure/index.ts#L58)
[features/measure/index.ts:59](https://github.com/phun-ky/speccer/blob/main/src/features/measure/index.ts#L59)

---

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

# features/pin

> Last updated 2024-08-22T06:56:09.100Z
> Last updated 2024-08-23T11:58:26.659Z
This feature highlights the anatomy of an element.

Expand Down Expand Up @@ -75,7 +75,7 @@ pinElements(sectionElement);

#### Defined in

[features/pin/index.ts:43](https://github.com/phun-ky/speccer/blob/main/src/features/pin/index.ts#L43)
[features/pin/index.ts:44](https://github.com/phun-ky/speccer/blob/main/src/features/pin/index.ts#L44)

---

Expand Down
2 changes: 1 addition & 1 deletion api/features/pin/utils/create-pin-element.md
View file
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-22T06:56:09.100Z
> Last updated 2024-08-23T11:58:26.660Z
## Functions

Expand Down
13 changes: 7 additions & 6 deletions api/features/pin/utils/get-character-to-use.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,25 @@

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

> Last updated 2024-08-22T06:56:09.101Z
> Last updated 2024-08-23T11:58:26.660Z
## Functions

### getCharacterToUse()

```ts
function getCharacterToUse(targetIndex): string;
function getCharacterToUse(targetIndex, literalsToUse): string;
```

Returns the character to use at the specified target index.
If the index exceeds the available characters, it generates a new character by pairing uppercase and lowercase letters.

#### Parameters

| Parameter | Type | Description |
| ------------- | -------- | --------------------------------------- |
| `targetIndex` | `number` | The index of the character to retrieve. |
| Parameter | Type | Description |
| --------------- | ----------------------- | --------------------------------------- |
| `targetIndex` | `number` | The index of the character to retrieve. |
| `literalsToUse` | `string` \| `string`\[] | Literals to use |

#### Returns

Expand All @@ -40,7 +41,7 @@ const nextCharacter = getCharacterToUse(25); // Returns next character or a gene

#### Defined in

[features/pin/utils/get-character-to-use.ts:18](https://github.com/phun-ky/speccer/blob/main/src/features/pin/utils/get-character-to-use.ts#L18)
[features/pin/utils/get-character-to-use.ts:17](https://github.com/phun-ky/speccer/blob/main/src/features/pin/utils/get-character-to-use.ts#L17)

---

Expand Down
2 changes: 1 addition & 1 deletion api/features/pin/utils/pin-element.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# features/pin/utils/pin-element

> Last updated 2024-08-22T06:56:09.101Z
> Last updated 2024-08-23T11:58:26.660Z
## Functions

Expand Down
2 changes: 1 addition & 1 deletion api/features/pin/utils/styles.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# features/pin/utils/styles

> Last updated 2024-08-22T06:56:09.102Z
> Last updated 2024-08-23T11:58:26.660Z
## Functions

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

# features/spacing

> Last updated 2024-08-22T06:56:09.102Z
> Last updated 2024-08-23T11:58:26.661Z
## Functions

Expand Down
2 changes: 1 addition & 1 deletion api/features/spacing/utils/position.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# features/spacing/utils/position

> Last updated 2024-08-22T06:56:09.103Z
> Last updated 2024-08-23T11:58:26.661Z
## Functions

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

# features/typography

> Last updated 2024-08-22T06:56:09.103Z
> Last updated 2024-08-23T11:58:26.661Z
## Functions

Expand Down
2 changes: 1 addition & 1 deletion api/features/typography/utils/position.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# features/typography/utils/position

> Last updated 2024-08-22T06:56:09.104Z
> Last updated 2024-08-23T11:58:26.661Z
## Functions

Expand Down
2 changes: 1 addition & 1 deletion api/features/typography/utils/template.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# features/typography/utils/template

> Last updated 2024-08-22T06:56:09.105Z
> Last updated 2024-08-23T11:58:26.662Z
## Functions

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

# main

> Last updated 2024-08-22T06:56:09.105Z
> Last updated 2024-08-23T11:58:26.663Z
## Table of Contents

Expand Down
2 changes: 1 addition & 1 deletion api/types/bezier.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# types/bezier

> Last updated 2024-08-22T06:56:09.107Z
> Last updated 2024-08-23T11:58:26.664Z
## Type Aliases

Expand Down
2 changes: 1 addition & 1 deletion api/types/css.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# types/css

> Last updated 2024-08-22T06:56:09.108Z
> Last updated 2024-08-23T11:58:26.664Z
## Type Aliases

Expand Down
2 changes: 1 addition & 1 deletion api/types/debounce.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# types/debounce

> Last updated 2024-08-22T06:56:09.109Z
> Last updated 2024-08-23T11:58:26.665Z
## Type Aliases

Expand Down
33 changes: 17 additions & 16 deletions api/types/enums/area.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# types/enums/area

> Last updated 2024-08-22T06:56:09.109Z
> Last updated 2024-08-23T11:58:26.665Z
## Enumerations

Expand All @@ -18,7 +18,7 @@ Enum representing different grid areas.

| Enumeration Member | Value | Defined in |
| ------------------ | -------- | -------------------------------------------------------------------------------------------------- |
| `Grid` | `"grid"` | [types/enums/area.ts:74](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L74) |
| `Grid` | `"grid"` | [types/enums/area.ts:75](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L75) |

---

Expand All @@ -30,7 +30,7 @@ Enum representing different mark areas.

| Enumeration Member | Value | Defined in |
| ------------------ | -------- | -------------------------------------------------------------------------------------------------- |
| `Mark` | `"mark"` | [types/enums/area.ts:67](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L67) |
| `Mark` | `"mark"` | [types/enums/area.ts:68](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L68) |

---

Expand All @@ -42,13 +42,14 @@ Enum representing different measurement areas.

| Enumeration Member | Value | Defined in |
| ------------------ | ----------- | -------------------------------------------------------------------------------------------------- |
| `Bottom` | `"bottom"` | [types/enums/area.ts:40](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L40) |
| `Height` | `"height"` | [types/enums/area.ts:37](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L37) |
| `Left` | `"left"` | [types/enums/area.ts:38](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L38) |
| `Bottom` | `"bottom"` | [types/enums/area.ts:41](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L41) |
| `Height` | `"height"` | [types/enums/area.ts:38](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L38) |
| `Left` | `"left"` | [types/enums/area.ts:39](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L39) |
| `Measure` | `"measure"` | [types/enums/area.ts:35](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L35) |
| `Right` | `"right"` | [types/enums/area.ts:39](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L39) |
| `Top` | `"top"` | [types/enums/area.ts:41](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L41) |
| `Width` | `"width"` | [types/enums/area.ts:36](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L36) |
| `Right` | `"right"` | [types/enums/area.ts:40](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L40) |
| `Slim` | `"slim"` | [types/enums/area.ts:36](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L36) |
| `Top` | `"top"` | [types/enums/area.ts:42](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L42) |
| `Width` | `"width"` | [types/enums/area.ts:37](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L37) |

---

Expand Down Expand Up @@ -82,7 +83,7 @@ Enum representing different spacing areas.

| Enumeration Member | Value | Defined in |
| ------------------ | ----------- | -------------------------------------------------------------------------------------------------- |
| `Spacing` | `"spacing"` | [types/enums/area.ts:60](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L60) |
| `Spacing` | `"spacing"` | [types/enums/area.ts:61](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L61) |

---

Expand Down Expand Up @@ -110,12 +111,12 @@ Enum representing different typography areas.

| Enumeration Member | Value | Defined in |
| ------------------ | -------------- | -------------------------------------------------------------------------------------------------- |
| `Bottom` | `"bottom"` | [types/enums/area.ts:52](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L52) |
| `Left` | `"left"` | [types/enums/area.ts:50](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L50) |
| `Right` | `"right"` | [types/enums/area.ts:51](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L51) |
| `Syntax` | `"syntax"` | [types/enums/area.ts:49](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L49) |
| `Top` | `"top"` | [types/enums/area.ts:53](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L53) |
| `Typography` | `"typography"` | [types/enums/area.ts:48](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L48) |
| `Bottom` | `"bottom"` | [types/enums/area.ts:53](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L53) |
| `Left` | `"left"` | [types/enums/area.ts:51](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L51) |
| `Right` | `"right"` | [types/enums/area.ts:52](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L52) |
| `Syntax` | `"syntax"` | [types/enums/area.ts:50](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L50) |
| `Top` | `"top"` | [types/enums/area.ts:54](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L54) |
| `Typography` | `"typography"` | [types/enums/area.ts:49](https://github.com/phun-ky/speccer/blob/main/src/types/enums/area.ts#L49) |

---

Expand Down
2 changes: 1 addition & 1 deletion api/types/interfaces/attributes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# types/interfaces/attributes

> Last updated 2024-08-22T06:56:09.110Z
> Last updated 2024-08-23T11:58:26.666Z
## Interfaces

Expand Down
2 changes: 1 addition & 1 deletion api/types/interfaces/classnames.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# types/interfaces/classnames

> Last updated 2024-08-22T06:56:09.111Z
> Last updated 2024-08-23T11:58:26.666Z
## Type Aliases

Expand Down
2 changes: 1 addition & 1 deletion api/types/interfaces/global.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# types/interfaces/global

> Last updated 2024-08-22T06:56:09.111Z
> Last updated 2024-08-23T11:58:26.666Z
## Interfaces

Expand Down
2 changes: 1 addition & 1 deletion api/types/interfaces/position.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# types/interfaces/position

> Last updated 2024-08-22T06:56:09.112Z
> Last updated 2024-08-23T11:58:26.667Z
## Interfaces

Expand Down
2 changes: 1 addition & 1 deletion api/types/position.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# types/position

> Last updated 2024-08-22T06:56:09.112Z
> Last updated 2024-08-23T11:58:26.667Z
## Type Aliases

Expand Down
Loading

0 comments on commit fb5ec15

Please sign in to comment.