npm - @siemens/ix-docs - Versions diffs - 4.0.0 → 4.2.0 - Mend

@siemens/ix-docs 4.0.0 → 4.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (853) hide show

package/build/docs/autogenerated/prompt/ix-menu-avatar/readme.md CHANGED Viewed

@@ -1,230 +1,3 @@
-# ix-menu-avatar
-## HTML Examples
-### Example: vertical-tabs-with-avatar
-```html
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Vertical tabs with avatar example</title>
-    <link rel="stylesheet" href="./vertical-tabs-with-avatar.css" />
-    <script type="module">
-      import { addIcons } from '@siemens/ix-icons';
-      import {
-        iconUserProfile,
-        iconHome,
-        iconGlobe,
-        iconStar,
-      } from '@siemens/ix-icons/icons';
-      addIcons({
-        iconUserProfile,
-        iconHome,
-        iconGlobe,
-        iconStar,
-      });
-    </script>
-  </head>
-  <body>
-    <ix-menu>
-      <ix-menu-avatar
-        top="john.doe@company.com"
-        bottom="Administrator"
-        image="https://ui-avatars.com/api/?name=John+Doe"
-      >
-        <ix-menu-avatar-item
-          icon="user-profile"
-          label="User profile..."
-        ></ix-menu-avatar-item>
-      </ix-menu-avatar>
-      <ix-menu-item home icon="home">Home</ix-menu-item>
-      <ix-menu-item icon="globe">Normal tab</ix-menu-item>
-      <ix-menu-item icon="star" disabled>Disabled tab</ix-menu-item>
-      <ix-menu-item icon="star">With other icon</ix-menu-item>
-      <ix-menu-item icon="globe" style="display: none">
-        Should not be visible
-      </ix-menu-item>
-    </ix-menu>
-    <script type="module" src="./init.js"></script>
-  </body>
-</html>
-```
-## React Examples
-### Example: vertical-tabs-with-avatar
-```tsx
-import {
-  iconGlobe,
-  iconHome,
-  iconStar,
-  iconUserProfile,
-} from '@siemens/ix-icons/icons';
-import './vertical-tabs-with-avatar.scoped.css';
-import {
-  IxMenu,
-  IxMenuAvatar,
-  IxMenuAvatarItem,
-  IxMenuItem,
-} from '@siemens/ix-react';
-export default () => {
-  return (
-    <IxMenu>
-      <IxMenuAvatar
-        top="john.doe@company.com"
-        bottom="Administrator"
-        image="https://ui-avatars.com/api/?name=John+Doe"
-      >
-        <IxMenuAvatarItem
-          icon={iconUserProfile}
-          label="User profile..."
-        ></IxMenuAvatarItem>
-      </IxMenuAvatar>
-      <IxMenuItem home icon={iconHome}>
-        Home
-      </IxMenuItem>
-      <IxMenuItem icon={iconGlobe}>Normal tab</IxMenuItem>
-      <IxMenuItem icon={iconStar} disabled>
-        Disabled Tab
-      </IxMenuItem>
-      <IxMenuItem icon={iconStar}>With other icon</IxMenuItem>
-      <IxMenuItem icon={iconStar} style={{ display: 'none' }}>
-        Should not be visible
-      </IxMenuItem>
-    </IxMenu>
-  );
-};
-```
-## Vue Examples
-### Example: vertical-tabs-with-avatar
-```tsx
-<script setup lang="ts">
-import {
-  iconGlobe,
-  iconHome,
-  iconStar,
-  iconUserProfile,
-} from '@siemens/ix-icons/icons';
-import {
-  IxMenu,
-  IxMenuAvatar,
-  IxMenuAvatarItem,
-  IxMenuItem,
-} from '@siemens/ix-vue';
-</script>
-<style scoped src="./vertical-tabs-with-avatar.css"></style>
-<template>
-  <IxMenu>
-    <IxMenuAvatar top="john.doe@company.com" bottom="Administrator">
-      <IxMenuAvatarItem
-        :icon="iconUserProfile"
-        label="User profile..."
-      ></IxMenuAvatarItem>
-    </IxMenuAvatar>
-    <IxMenuItem home-tab :icon="iconHome">Home</IxMenuItem>
-    <IxMenuItem :icon="iconGlobe">Normal tab</IxMenuItem>
-    <IxMenuItem :icon="iconStar" disabled>Disabled tab</IxMenuItem>
-    <IxMenuItem :icon="iconStar">With other icon</IxMenuItem>
-    <IxMenuItem :icon="iconStar" style="display: none"
-      >Should not be visible</IxMenuItem
-    >
-  </IxMenu>
-</template>
-```
-## Angular Examples
-### Example: vertical-tabs-with-avatar
-#### Component typescript
-```typescript
-import { Component } from '@angular/core';
-@Component({
-  standalone: false,
-  selector: 'app-example',
-  template: `
-    <ix-menu>
-      <ix-menu-avatar
-        top="john.doe@company.com"
-        bottom="Administrator"
-        image="https://ui-avatars.com/api/?name=John+Doe"
-      >
-        <ix-menu-avatar-item
-          icon="user-profile"
-          label="User profile..."
-        ></ix-menu-avatar-item>
-      </ix-menu-avatar>
-      <ix-menu-item home-tab icon="home">Home</ix-menu-item>
-      <ix-menu-item icon="globe">Normal tab</ix-menu-item>
-      <ix-menu-item icon="star" disabled>Disabled tab</ix-menu-item>
-      <ix-menu-item icon="star">With other icon</ix-menu-item>
-      <ix-menu-item icon="globe" style="display: none">
-        Should not be visible
-      </ix-menu-item>
-    </ix-menu>
-  `,
-  styleUrls: ['./vertical-tabs-with-avatar.css'],
-})
-export default class VerticalTabsWithAvatar {}
-```
-## Angular Standalone Examples
-### Example: vertical-tabs-with-avatar
-#### Component typescript
-```typescript
-import { Component } from '@angular/core';
-import {
-  IxMenu,
-  IxMenuAvatar,
-  IxMenuAvatarItem,
-  IxMenuItem,
-} from '@siemens/ix-angular/standalone';
-@Component({
-  selector: 'app-example',
-  imports: [IxMenu, IxMenuAvatar, IxMenuAvatarItem, IxMenuItem],
-  template: `
-    <ix-menu>
-      <ix-menu-avatar
-        top="john.doe@company.com"
-        bottom="Administrator"
-        image="https://ui-avatars.com/api/?name=John+Doe"
-      >
-        <ix-menu-avatar-item
-          icon="user-profile"
-          label="User profile..."
-        ></ix-menu-avatar-item>
-      </ix-menu-avatar>
-      <ix-menu-item home-tab icon="home">Home</ix-menu-item>
-      <ix-menu-item icon="globe">Normal tab</ix-menu-item>
-      <ix-menu-item icon="star" disabled>Disabled tab</ix-menu-item>
-      <ix-menu-item icon="star">With other icon</ix-menu-item>
-      <ix-menu-item icon="globe" style="display: none">
-        Should not be visible
-      </ix-menu-item>
-    </ix-menu>
-  `,
-  styleUrls: ['./vertical-tabs-with-avatar.css'],
-})
-export default class VerticalTabsWithAvatar {}
-```
 <!-- Auto Generated Below -->

package/build/docs/autogenerated/prompt/ix-menu-avatar-item/readme.md CHANGED Viewed

@@ -1,230 +1,3 @@
-# ix-menu-avatar-item
-## HTML Examples
-### Example: vertical-tabs-with-avatar
-```html
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Vertical tabs with avatar example</title>
-    <link rel="stylesheet" href="./vertical-tabs-with-avatar.css" />
-    <script type="module">
-      import { addIcons } from '@siemens/ix-icons';
-      import {
-        iconUserProfile,
-        iconHome,
-        iconGlobe,
-        iconStar,
-      } from '@siemens/ix-icons/icons';
-      addIcons({
-        iconUserProfile,
-        iconHome,
-        iconGlobe,
-        iconStar,
-      });
-    </script>
-  </head>
-  <body>
-    <ix-menu>
-      <ix-menu-avatar
-        top="john.doe@company.com"
-        bottom="Administrator"
-        image="https://ui-avatars.com/api/?name=John+Doe"
-      >
-        <ix-menu-avatar-item
-          icon="user-profile"
-          label="User profile..."
-        ></ix-menu-avatar-item>
-      </ix-menu-avatar>
-      <ix-menu-item home icon="home">Home</ix-menu-item>
-      <ix-menu-item icon="globe">Normal tab</ix-menu-item>
-      <ix-menu-item icon="star" disabled>Disabled tab</ix-menu-item>
-      <ix-menu-item icon="star">With other icon</ix-menu-item>
-      <ix-menu-item icon="globe" style="display: none">
-        Should not be visible
-      </ix-menu-item>
-    </ix-menu>
-    <script type="module" src="./init.js"></script>
-  </body>
-</html>
-```
-## React Examples
-### Example: vertical-tabs-with-avatar
-```tsx
-import {
-  iconGlobe,
-  iconHome,
-  iconStar,
-  iconUserProfile,
-} from '@siemens/ix-icons/icons';
-import './vertical-tabs-with-avatar.scoped.css';
-import {
-  IxMenu,
-  IxMenuAvatar,
-  IxMenuAvatarItem,
-  IxMenuItem,
-} from '@siemens/ix-react';
-export default () => {
-  return (
-    <IxMenu>
-      <IxMenuAvatar
-        top="john.doe@company.com"
-        bottom="Administrator"
-        image="https://ui-avatars.com/api/?name=John+Doe"
-      >
-        <IxMenuAvatarItem
-          icon={iconUserProfile}
-          label="User profile..."
-        ></IxMenuAvatarItem>
-      </IxMenuAvatar>
-      <IxMenuItem home icon={iconHome}>
-        Home
-      </IxMenuItem>
-      <IxMenuItem icon={iconGlobe}>Normal tab</IxMenuItem>
-      <IxMenuItem icon={iconStar} disabled>
-        Disabled Tab
-      </IxMenuItem>
-      <IxMenuItem icon={iconStar}>With other icon</IxMenuItem>
-      <IxMenuItem icon={iconStar} style={{ display: 'none' }}>
-        Should not be visible
-      </IxMenuItem>
-    </IxMenu>
-  );
-};
-```
-## Vue Examples
-### Example: vertical-tabs-with-avatar
-```tsx
-<script setup lang="ts">
-import {
-  iconGlobe,
-  iconHome,
-  iconStar,
-  iconUserProfile,
-} from '@siemens/ix-icons/icons';
-import {
-  IxMenu,
-  IxMenuAvatar,
-  IxMenuAvatarItem,
-  IxMenuItem,
-} from '@siemens/ix-vue';
-</script>
-<style scoped src="./vertical-tabs-with-avatar.css"></style>
-<template>
-  <IxMenu>
-    <IxMenuAvatar top="john.doe@company.com" bottom="Administrator">
-      <IxMenuAvatarItem
-        :icon="iconUserProfile"
-        label="User profile..."
-      ></IxMenuAvatarItem>
-    </IxMenuAvatar>
-    <IxMenuItem home-tab :icon="iconHome">Home</IxMenuItem>
-    <IxMenuItem :icon="iconGlobe">Normal tab</IxMenuItem>
-    <IxMenuItem :icon="iconStar" disabled>Disabled tab</IxMenuItem>
-    <IxMenuItem :icon="iconStar">With other icon</IxMenuItem>
-    <IxMenuItem :icon="iconStar" style="display: none"
-      >Should not be visible</IxMenuItem
-    >
-  </IxMenu>
-</template>
-```
-## Angular Examples
-### Example: vertical-tabs-with-avatar
-#### Component typescript
-```typescript
-import { Component } from '@angular/core';
-@Component({
-  standalone: false,
-  selector: 'app-example',
-  template: `
-    <ix-menu>
-      <ix-menu-avatar
-        top="john.doe@company.com"
-        bottom="Administrator"
-        image="https://ui-avatars.com/api/?name=John+Doe"
-      >
-        <ix-menu-avatar-item
-          icon="user-profile"
-          label="User profile..."
-        ></ix-menu-avatar-item>
-      </ix-menu-avatar>
-      <ix-menu-item home-tab icon="home">Home</ix-menu-item>
-      <ix-menu-item icon="globe">Normal tab</ix-menu-item>
-      <ix-menu-item icon="star" disabled>Disabled tab</ix-menu-item>
-      <ix-menu-item icon="star">With other icon</ix-menu-item>
-      <ix-menu-item icon="globe" style="display: none">
-        Should not be visible
-      </ix-menu-item>
-    </ix-menu>
-  `,
-  styleUrls: ['./vertical-tabs-with-avatar.css'],
-})
-export default class VerticalTabsWithAvatar {}
-```
-## Angular Standalone Examples
-### Example: vertical-tabs-with-avatar
-#### Component typescript
-```typescript
-import { Component } from '@angular/core';
-import {
-  IxMenu,
-  IxMenuAvatar,
-  IxMenuAvatarItem,
-  IxMenuItem,
-} from '@siemens/ix-angular/standalone';
-@Component({
-  selector: 'app-example',
-  imports: [IxMenu, IxMenuAvatar, IxMenuAvatarItem, IxMenuItem],
-  template: `
-    <ix-menu>
-      <ix-menu-avatar
-        top="john.doe@company.com"
-        bottom="Administrator"
-        image="https://ui-avatars.com/api/?name=John+Doe"
-      >
-        <ix-menu-avatar-item
-          icon="user-profile"
-          label="User profile..."
-        ></ix-menu-avatar-item>
-      </ix-menu-avatar>
-      <ix-menu-item home-tab icon="home">Home</ix-menu-item>
-      <ix-menu-item icon="globe">Normal tab</ix-menu-item>
-      <ix-menu-item icon="star" disabled>Disabled tab</ix-menu-item>
-      <ix-menu-item icon="star">With other icon</ix-menu-item>
-      <ix-menu-item icon="globe" style="display: none">
-        Should not be visible
-      </ix-menu-item>
-    </ix-menu>
-  `,
-  styleUrls: ['./vertical-tabs-with-avatar.css'],
-})
-export default class VerticalTabsWithAvatar {}
-```
 <!-- Auto Generated Below -->