diff --git a/core/src/components.d.ts b/core/src/components.d.ts index a91597b370..69feb020ca 100644 --- a/core/src/components.d.ts +++ b/core/src/components.d.ts @@ -1225,7 +1225,7 @@ export namespace Components { */ "close": (animated?: boolean) => Promise; /** - * The content's id the menu should use. + * The `id` of the main content. When using a router this is typically `ion-router-outlet`. When not using a router, this is typically your main view's `ion-content`. This is not the id of the `ion-content` inside of your `ion-menu`. */ "contentId"?: string; /** @@ -2303,7 +2303,7 @@ export namespace Components { } interface IonSplitPane { /** - * The content `id` of the split-pane's main content. + * The `id` of the main content. When using a router this is typically `ion-router-outlet`. When not using a router, this is typically your main view's `ion-content`. This is not the id of the `ion-content` inside of your `ion-menu`. */ "contentId"?: string; /** @@ -4568,7 +4568,7 @@ declare namespace LocalJSX { } interface IonMenu { /** - * The content's id the menu should use. + * The `id` of the main content. When using a router this is typically `ion-router-outlet`. When not using a router, this is typically your main view's `ion-content`. This is not the id of the `ion-content` inside of your `ion-menu`. */ "contentId"?: string; /** @@ -5625,7 +5625,7 @@ declare namespace LocalJSX { } interface IonSplitPane { /** - * The content `id` of the split-pane's main content. + * The `id` of the main content. When using a router this is typically `ion-router-outlet`. When not using a router, this is typically your main view's `ion-content`. This is not the id of the `ion-content` inside of your `ion-menu`. */ "contentId"?: string; /** diff --git a/core/src/components/menu/menu.tsx b/core/src/components/menu/menu.tsx index f0ae525de9..452125a29a 100644 --- a/core/src/components/menu/menu.tsx +++ b/core/src/components/menu/menu.tsx @@ -46,7 +46,11 @@ export class Menu implements ComponentInterface, MenuI { @State() isEndSide = false; /** - * The content's id the menu should use. + * The `id` of the main content. When using + * a router this is typically `ion-router-outlet`. + * When not using a router, this is typically + * your main view's `ion-content`. This is not the + * id of the `ion-content` inside of your `ion-menu`. */ @Prop({ reflect: true }) contentId?: string; diff --git a/core/src/components/menu/readme.md b/core/src/components/menu/readme.md index 2a596cc14d..e9ac7596b7 100644 --- a/core/src/components/menu/readme.md +++ b/core/src/components/menu/readme.md @@ -477,15 +477,15 @@ export default defineComponent({ ## Properties -| Property | Attribute | Description | Type | Default | -| -------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------ | --------------------- | ----------- | -| `contentId` | `content-id` | The content's id the menu should use. | `string \| undefined` | `undefined` | -| `disabled` | `disabled` | If `true`, the menu is disabled. | `boolean` | `false` | -| `maxEdgeStart` | `max-edge-start` | The edge threshold for dragging the menu open. If a drag/swipe happens over this value, the menu is not triggered. | `number` | `50` | -| `menuId` | `menu-id` | An id for the menu. | `string \| undefined` | `undefined` | -| `side` | `side` | Which side of the view the menu should be placed. | `"end" \| "start"` | `'start'` | -| `swipeGesture` | `swipe-gesture` | If `true`, swiping the menu is enabled. | `boolean` | `true` | -| `type` | `type` | The display type of the menu. Available options: `"overlay"`, `"reveal"`, `"push"`. | `string \| undefined` | `undefined` | +| Property | Attribute | Description | Type | Default | +| -------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | ----------- | +| `contentId` | `content-id` | The `id` of the main content. When using a router this is typically `ion-router-outlet`. When not using a router, this is typically your main view's `ion-content`. This is not the id of the `ion-content` inside of your `ion-menu`. | `string \| undefined` | `undefined` | +| `disabled` | `disabled` | If `true`, the menu is disabled. | `boolean` | `false` | +| `maxEdgeStart` | `max-edge-start` | The edge threshold for dragging the menu open. If a drag/swipe happens over this value, the menu is not triggered. | `number` | `50` | +| `menuId` | `menu-id` | An id for the menu. | `string \| undefined` | `undefined` | +| `side` | `side` | Which side of the view the menu should be placed. | `"end" \| "start"` | `'start'` | +| `swipeGesture` | `swipe-gesture` | If `true`, swiping the menu is enabled. | `boolean` | `true` | +| `type` | `type` | The display type of the menu. Available options: `"overlay"`, `"reveal"`, `"push"`. | `string \| undefined` | `undefined` | ## Events diff --git a/core/src/components/split-pane/readme.md b/core/src/components/split-pane/readme.md index 0f6f5ec4b5..32e7381ff4 100644 --- a/core/src/components/split-pane/readme.md +++ b/core/src/components/split-pane/readme.md @@ -187,11 +187,11 @@ export default defineComponent({ ## Properties -| Property | Attribute | Description | Type | Default | -| ----------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | ------------- | -| `contentId` | `content-id` | The content `id` of the split-pane's main content. | `string \| undefined` | `undefined` | -| `disabled` | `disabled` | If `true`, the split pane will be hidden. | `boolean` | `false` | -| `when` | `when` | When the split-pane should be shown. Can be a CSS media query expression, or a shortcut expression. Can also be a boolean expression. | `boolean \| string` | `QUERY['lg']` | +| Property | Attribute | Description | Type | Default | +| ----------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | ------------- | +| `contentId` | `content-id` | The `id` of the main content. When using a router this is typically `ion-router-outlet`. When not using a router, this is typically your main view's `ion-content`. This is not the id of the `ion-content` inside of your `ion-menu`. | `string \| undefined` | `undefined` | +| `disabled` | `disabled` | If `true`, the split pane will be hidden. | `boolean` | `false` | +| `when` | `when` | When the split-pane should be shown. Can be a CSS media query expression, or a shortcut expression. Can also be a boolean expression. | `boolean \| string` | `QUERY['lg']` | ## Events diff --git a/core/src/components/split-pane/split-pane.tsx b/core/src/components/split-pane/split-pane.tsx index d782cd0b9a..6f2fb805ff 100644 --- a/core/src/components/split-pane/split-pane.tsx +++ b/core/src/components/split-pane/split-pane.tsx @@ -29,7 +29,11 @@ export class SplitPane implements ComponentInterface { @State() visible = false; /** - * The content `id` of the split-pane's main content. + * The `id` of the main content. When using + * a router this is typically `ion-router-outlet`. + * When not using a router, this is typically + * your main view's `ion-content`. This is not the + * id of the `ion-content` inside of your `ion-menu`. */ @Prop({ reflect: true }) contentId?: string;