diff --git a/COMPONENT_INDEX.md b/COMPONENT_INDEX.md index dc437397..5e3725a0 100644 --- a/COMPONENT_INDEX.md +++ b/COMPONENT_INDEX.md @@ -256,9 +256,9 @@ None. ### Props -| Prop name | Required | Kind | Reactive | Type | Default value | Description | -| :-------- | :------- | :--------------- | :------- | ---------------------------------------------------------------------------------------------------------------------------- | ------------------ | ------------------------ | -| ratio | No | let | No | "2x1" | "2x3" | "16x9" | "4x3" | "1x1" | "3x4" | "3x2" | "9x16" | "1x2" | "2x1" | Specify the aspect ratio | +| Prop name | Required | Kind | Reactive | Type | Default value | Description | +| :-------- | :------- | :--------------- | :------- | ---------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | +| ratio | No | let | No | "2x1" | "2x3" | "16x9" | "4x3" | "1x1" | "3x4" | "3x2" | "9x16" | "1x2" | "2x1" | Specify the ratio to be used by the aspect ratio container.
This will determine what aspect ratio your content will be displayed in. | ### Slots diff --git a/docs/package-lock.json b/docs/package-lock.json index 1a9b52b1..10fc43c4 100644 --- a/docs/package-lock.json +++ b/docs/package-lock.json @@ -25,7 +25,7 @@ } }, "..": { - "version": "1.0.0-next.0", + "version": "1.0.0-next.1", "dev": true, "license": "Apache-2.0", "dependencies": { diff --git a/docs/src/COMPONENT_API.json b/docs/src/COMPONENT_API.json index 60018cc2..da6d45d8 100644 --- a/docs/src/COMPONENT_API.json +++ b/docs/src/COMPONENT_API.json @@ -228,7 +228,7 @@ { "name": "ratio", "kind": "let", - "description": "Specify the aspect ratio", + "description": "Specify the ratio to be used by the aspect ratio container.\nThis will determine what aspect ratio your content will be displayed in.", "type": "\"2x1\" | \"2x3\" | \"16x9\" | \"4x3\" | \"1x1\" | \"3x4\" | \"3x2\" | \"9x16\" | \"1x2\"", "value": "\"2x1\"", "isFunction": false, diff --git a/types/AspectRatio/AspectRatio.svelte.d.ts b/types/AspectRatio/AspectRatio.svelte.d.ts index 36ded804..fedad411 100644 --- a/types/AspectRatio/AspectRatio.svelte.d.ts +++ b/types/AspectRatio/AspectRatio.svelte.d.ts @@ -1,11 +1,9 @@ import type { SvelteComponentTyped } from "svelte"; -import type { SvelteHTMLElements } from "svelte/elements"; -type RestProps = SvelteHTMLElements["div"]; - -export interface AspectRatioProps extends RestProps { +export interface AspectRatioProps { /** - * Specify the aspect ratio + * Specify the ratio to be used by the aspect ratio container. + * This will determine what aspect ratio your content will be displayed in. * @default "2x1" */ ratio?: