mcp/carbon-components-svelte
1
0
Fork 0
mirror of https://github.com/carbon-design-system/carbon-components-svelte.git synced 2025-09-18 03:26:36 +00:00
Code Issues Projects Releases Packages Wiki Activity

Updated AspectRatio documentation

Browse source
This commit is contained in:
mabentley85 2024-04-02 15:49:32 -07:00
commit 3bdb9baa8a
4 changed files with 8 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

6
COMPONENT_INDEX.md
View file

@ -256,9 +256,9 @@ None.
### Props
| Prop name | Required | Kind | Reactive | Type | Default value | Description |
| :-------- | :------- | :--------------- | :------- | ---------------------------------------------------------------------------------------------------------------------------- | ------------------ | ------------------------ |
| ratio | No | <code>let</code> | No | <code>"2x1" &#124; "2x3" &#124; "16x9" &#124; "4x3" &#124; "1x1" &#124; "3x4" &#124; "3x2" &#124; "9x16" &#124; "1x2"</code> | <code>"2x1"</code> | Specify the aspect ratio |
| Prop name | Required | Kind | Reactive | Type | Default value | Description |
| :-------- | :------- | :--------------- | :------- | ---------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
| ratio | No | <code>let</code> | No | <code>"2x1" &#124; "2x3" &#124; "16x9" &#124; "4x3" &#124; "1x1" &#124; "3x4" &#124; "3x2" &#124; "9x16" &#124; "1x2"</code> | <code>"2x1"</code> | Specify the ratio to be used by the aspect ratio container.<br />This will determine what aspect ratio your content will be displayed in. |
### Slots

2
docs/package-lock.json generated
View file

@ -25,7 +25,7 @@
}
},
"..": {
"version": "1.0.0-next.0",
"version": "1.0.0-next.1",
"dev": true,
"license": "Apache-2.0",
"dependencies": {

2
docs/src/COMPONENT_API.json
View file

@ -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,

8
types/AspectRatio/AspectRatio.svelte.d.ts vendored
View file

@ -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?: