Skip to content

Commit

Permalink
chore: 🤖 release v11.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
phun-ky committed Aug 30, 2024
1 parent 09e4dab commit a35d90b
Show file tree
Hide file tree
Showing 65 changed files with 214 additions and 79 deletions.
41 changes: 41 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,46 @@
# Changelog

## [11.1.0](https://github.com/phun-ky/speccer/compare/v11.0.0...v11.1.0) (2024-08-30)


### Tasks

* 🤖 Update `SECURITY.md` ([884ac79](https://github.com/phun-ky/speccer/commit/884ac79b5b4e2c4b7fef8857b51eda6f7032fed3))


### Documentation

* ✏️ Regenerate API documentation ([b34036f](https://github.com/phun-ky/speccer/commit/b34036fa1180b1945927ba0f6153849546fc033e))
* ✏️ Update screenshots and add more feature documentation ([095e9a1](https://github.com/phun-ky/speccer/commit/095e9a10c41261516fed0b8cbaefbf51d5d84f13))
* ✏️ use `` instead of `...` ([3869cf0](https://github.com/phun-ky/speccer/commit/3869cf0fae86aac1640714f7c8cdb9bec0e9ec6c))


### Feature

* 🎸 Add `bound` option to the `spacing` feature ([65e7314](https://github.com/phun-ky/speccer/commit/65e7314e4e4b07840f43a41c324f1d9e7ae49517))
* 🎸 Add function to remove given speccer elements ([1078ca4](https://github.com/phun-ky/speccer/commit/1078ca4699497b221912c18f91676d600cc4c795))
* 🎸 Add missing stylesheet to `bound` option for `spacing` ([81bdfda](https://github.com/phun-ky/speccer/commit/81bdfda0e30b24bd0fbda321e2a923fe563b1839))
* 🎸 Add possibility to pass options programatically ([dd5a49e](https://github.com/phun-ky/speccer/commit/dd5a49e77144b593f14c9382f4eec9762244c4bc))


### Bug

* 🐛 Add missing features to lazy loading ([f97802e](https://github.com/phun-ky/speccer/commit/f97802e89bb7676fe8d465c7f624dd6bf0c20ca9))


### Performance change

* ⚡️ Return early if the element is hidden ([b09cecd](https://github.com/phun-ky/speccer/commit/b09cecd66158bdd3f4825a1b81efdc8fb26a423b))
* ⚡️ Use `waitForFrame` just in case ([70ca641](https://github.com/phun-ky/speccer/commit/70ca6410912d6e8d7e07470f6635a6d44aeafb5c))


### Refactoring

* 💡 Add missing types and refactor function ([470a77b](https://github.com/phun-ky/speccer/commit/470a77b934b5312b7fbbf6c637c0303b1038d398))
* 💡 Make position function return styles ([cf875f4](https://github.com/phun-ky/speccer/commit/cf875f49fe93a4d5b3a23e2028690ee96e331d95))
* 💡 Make sure we set a relation id to target elements ([b16054d](https://github.com/phun-ky/speccer/commit/b16054dd3d0fc9915da6a7cafb0fcdab77215400))
* 💡 Rename function, and move it to correct location ([79f532c](https://github.com/phun-ky/speccer/commit/79f532cdf7d7ab2e87282097ce98d1016e9054f9))

## [11.0.0](https://github.com/phun-ky/speccer/compare/v10.1.0...v11.0.0) (2024-08-28)


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

---

> Last updated 2024-08-30T19:21:42.296Z
> Last updated 2024-08-30T20:17:22.340Z
## Modules

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

# config/browser

> Last updated 2024-08-30T19:21:42.299Z
> Last updated 2024-08-30T20:17:22.342Z
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
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# features/a11y

> Last updated 2024-08-30T19:21:42.301Z
> Last updated 2024-08-30T20:17:22.346Z
This feature will highlight accessibility areas like landmarks and region. It can also display tab stops/sequence and any keyboard shortcuts assigned

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

# features/a11y/constants

> Last updated 2024-08-30T19:21:42.302Z
> Last updated 2024-08-30T20:17:22.347Z
## Variables

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

# features/a11y/utils/create-a11y-element

> Last updated 2024-08-30T19:21:42.303Z
> Last updated 2024-08-30T20:17:22.349Z
## Functions

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

# features/a11y/utils/styles

> Last updated 2024-08-30T19:21:42.303Z
> Last updated 2024-08-30T20:17:22.350Z
## Functions

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

# features/grid

> Last updated 2024-08-30T19:21:42.303Z
> Last updated 2024-08-30T20:17:22.350Z
This feature will highlight the grid spacing in a `display: grid;` element.

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

# features/mark

> Last updated 2024-08-30T19:21:42.304Z
> Last updated 2024-08-30T20:17:22.351Z
This feature marks given element

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

# features/measure

> Last updated 2024-08-30T19:21:42.304Z
> Last updated 2024-08-30T20:17:22.352Z
This feature measures given element

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

# features/pin

> Last updated 2024-08-30T19:21:42.305Z
> Last updated 2024-08-30T20:17:22.353Z
This feature highlights the anatomy of an element.

Expand Down
2 changes: 1 addition & 1 deletion api/features/pin/utils/create-pin-element.md
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-30T19:21:42.306Z
> Last updated 2024-08-30T20:17:22.354Z
## Functions

Expand Down
2 changes: 1 addition & 1 deletion api/features/pin/utils/get-character-to-use.md
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-30T19:21:42.306Z
> Last updated 2024-08-30T20:17:22.354Z
## Functions

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

# features/pin/utils/get-content-for-pin

> Last updated 2024-08-30T19:21:42.306Z
> Last updated 2024-08-30T20:17:22.355Z
## Functions

Expand Down
2 changes: 1 addition & 1 deletion api/features/pin/utils/pin-element.md
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-30T19:21:42.306Z
> Last updated 2024-08-30T20:17:22.355Z
## Functions

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

# features/pin/utils/styles

> Last updated 2024-08-30T19:21:42.307Z
> Last updated 2024-08-30T20:17:22.355Z
## Functions

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

# features/spacing

> Last updated 2024-08-30T19:21:42.307Z
> Last updated 2024-08-30T20:17:22.356Z
This feature highlights the spacing of an element.

Expand Down
25 changes: 11 additions & 14 deletions api/features/spacing/utils/position.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# features/spacing/utils/position

> Last updated 2024-08-30T19:21:42.307Z
> Last updated 2024-08-30T20:17:22.356Z
## Functions

Expand All @@ -16,41 +16,38 @@
function position(
property,
value,
spacingElement,
targetElement,
options?
): Promise<void>;
): Promise<undefined | PositionUnitPropertiesType>;
```

Set the position and dimensions of a spacing element relative to a target element.

#### Parameters

| Parameter | Type | Description |
| ---------------- | ------------------------------------------------------------------------------ | ---------------------------------------------------------------- |
| `property` | `string` | The CSS property to set (e.g., 'marginTop', 'marginLeft', etc.). |
| `value` | `number` | The value of the CSS property. |
| `spacingElement` | [`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement) | The spacing element. |
| `targetElement` | [`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement) | The target element. |
| `options`? | [`SpeccerOptionsInterface`](../../../types/speccer.md#specceroptionsinterface) | Options. |
| Parameter | Type | Description |
| --------------- | ------------------------------------------------------------------------------ | ---------------------------------------------------------------- |
| `property` | `string` | The CSS property to set (e.g., 'marginTop', 'marginLeft', etc.). |
| `value` | `number` | The value of the CSS property. |
| `targetElement` | [`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement) | The target element. |
| `options`? | [`SpeccerOptionsInterface`](../../../types/speccer.md#specceroptionsinterface) | Options. |

#### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`>
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`undefined` | [`PositionUnitPropertiesType`](../../../types/position.md#positionunitpropertiestype)>

- A promise that resolves after setting the position and dimensions.

#### Example

```ts
const spacingElement = document.getElementById('spacing');
const targetElement = document.getElementById('target');
position('marginTop', 20, spacingElement, targetElement);
position('marginTop', 20, targetElement);
```

#### Defined in

[features/spacing/utils/position.ts:23](https://github.com/phun-ky/speccer/blob/main/src/features/spacing/utils/position.ts#L23)
[features/spacing/utils/position.ts:21](https://github.com/phun-ky/speccer/blob/main/src/features/spacing/utils/position.ts#L21)

---

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

# features/typography

> Last updated 2024-08-30T19:21:42.307Z
> Last updated 2024-08-30T20:17:22.357Z
This feature presents typography

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

# features/typography/utils/position

> Last updated 2024-08-30T19:21:42.308Z
> Last updated 2024-08-30T20:17:22.357Z
## Functions

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

# features/typography/utils/template

> Last updated 2024-08-30T19:21:42.308Z
> Last updated 2024-08-30T20:17:22.359Z
## Functions

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

# main

> Last updated 2024-08-30T19:21:42.308Z
> Last updated 2024-08-30T20:17:22.359Z
## Table of Contents

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

# types/bezier

> Last updated 2024-08-30T19:21:42.310Z
> Last updated 2024-08-30T20:17:22.361Z
## Type Aliases

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

# types/css

> Last updated 2024-08-30T19:21:42.311Z
> Last updated 2024-08-30T20:17:22.363Z
## Type Aliases

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

# types/debounce

> Last updated 2024-08-30T19:21:42.311Z
> Last updated 2024-08-30T20:17:22.363Z
## Type Aliases

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

# types/enums/area

> Last updated 2024-08-30T19:21:42.311Z
> Last updated 2024-08-30T20:17:22.364Z
## Enumerations

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

# types/interfaces/attributes

> Last updated 2024-08-30T19:21:42.312Z
> Last updated 2024-08-30T20:17:22.367Z
## Interfaces

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

# types/interfaces/classnames

> Last updated 2024-08-30T19:21:42.312Z
> Last updated 2024-08-30T20:17:22.367Z
## Type Aliases

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

# types/interfaces/global

> Last updated 2024-08-30T19:21:42.312Z
> Last updated 2024-08-30T20:17:22.367Z
## Interfaces

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

# types/interfaces/position

> Last updated 2024-08-30T19:21:42.313Z
> Last updated 2024-08-30T20:17:22.368Z
## Interfaces

Expand Down
Loading

0 comments on commit a35d90b

Please sign in to comment.