@rancher/shell 3.0.5-rc.3 → 3.0.5-rc.6

package/rancher-components/RcItemCard/RcItemCard.test.ts

@@ -0,0 +1,189 @@
+import { mount } from '@vue/test-utils';
+import RcItemCard from './RcItemCard.vue';
+import RcItemCardAction from './RcItemCardAction.vue';
+
+class ResizeObserverMock {
+  observe = jest.fn();
+  unobserve = jest.fn();
+  disconnect = jest.fn();
+}
+
+global.ResizeObserver = ResizeObserverMock;
+
+const id = 'test';
+
+const baseProps = {
+  id,
+  value:  { someProperty: 'some-value' },
+  image:  { src: 'logo.png', alt: { text: 'Logo' } },
+  header: {
+    title:    { text: 'Card Title' },
+    statuses: [
+      { icon: 'icon-one', tooltip: { text: 'Status One' } },
+      { icon: 'icon-two' }
+    ]
+  },
+  content: { text: 'Card description here' }
+};
+
+describe('rcItemCard', () => {
+  it('renders title, image, and content', () => {
+    const wrapper = mount(RcItemCard, { props: baseProps });
+
+    expect(wrapper.get('[data-testid="item-card-header-title"]').text()).toBe('Card Title');
+    expect(wrapper.get('[data-testid="item-card-content"]').text()).toContain('Card description here');
+    expect(wrapper.get('[data-testid="item-card-image"]')).toBeTruthy();
+    expect(wrapper.findAll(`[data-testid="item-card-header-statuses-status"]`)).toHaveLength(2);
+  });
+
+  it('renders pill only in medium variant', () => {
+    const wrapper = mount(RcItemCard, {
+      props: {
+        ...baseProps,
+        variant: 'medium',
+        pill:    { label: { text: 'Installed' } }
+      }
+    });
+
+    expect(wrapper.get('[data-testid="item-card-pill"]').text()).toBe('Installed');
+
+    // now test that it's not rendered when variant is small
+    const wrapperSmall = mount(RcItemCard, {
+      props: {
+        ...baseProps,
+        variant: 'small',
+        pill:    { label: { text: 'Installed' } }
+      }
+    });
+
+    expect(wrapperSmall.find('[data-testid="item-card-pill"]').exists()).toBe(false);
+  });
+
+  it('renders action-menu if slot content is provided for it', () => {
+    const wrapper = mount(RcItemCard, {
+      props: { ...baseProps },
+      slots: { 'item-card-actions': '<div class="test-slot-for-actions">test</div>' }
+    });
+
+    expect(wrapper.find('.test-slot-for-actions').exists()).toBe(true);
+  });
+
+  it('renders action-menu when actions are passed as a prop', () => {
+    const wrapper = mount(RcItemCard, {
+      props: {
+        ...baseProps,
+        actions: [{ action: 'test', label: 'test' }]
+      }
+    });
+
+    expect(wrapper.findComponent('[data-testid="item-card-header-action-menu"]').exists()).toBe(true);
+  });
+
+  it('does not render action-menu if no slot and no actions', () => {
+    const wrapper = mount(RcItemCard, { props: { ...baseProps } });
+
+    expect(wrapper.findComponent('[data-testid="item-card-header-action-menu"]').exists()).toBe(false);
+  });
+
+  it('emits card-click when clicked and clickable', async() => {
+    const wrapper = mount(RcItemCard, {
+      props: {
+        ...baseProps,
+        clickable: true
+      }
+    });
+
+    await wrapper.trigger('click');
+
+    const emitted = wrapper.emitted('card-click');
+
+    expect(emitted).toBeTruthy();
+    expect(emitted?.[0]).toStrictEqual([{ someProperty: 'some-value' }]);
+  });
+
+  it('does not emit card-click when clicking on rc-item-card-action content', async() => {
+    const wrapper = mount(RcItemCard, {
+      props: {
+        ...baseProps,
+        clickable: true
+      },
+      global: { components: { RcItemCardAction } },
+      slots:  { 'item-card-actions': '<rc-item-card-action>Click me</rc-item-card-action>' }
+    });
+
+    await wrapper.get('[data-testid="rc-item-card-action"]').trigger('click');
+
+    expect(wrapper.emitted('card-click')).toBeFalsy();
+  });
+
+  it('sets role and tabindex when clickable', () => {
+    const wrapper = mount(RcItemCard, {
+      props: {
+        ...baseProps,
+        clickable: true
+      }
+    });
+
+    const root = wrapper.get(`[data-testid="item-card-${ id }"]`);
+
+    expect(root.attributes('role')).toBe('button');
+    expect(root.attributes('tabindex')).toBe('0');
+  });
+
+  it('does not set role or tabindex when not clickable', () => {
+    const wrapper = mount(RcItemCard, {
+      props: {
+        ...baseProps,
+        clickable: false
+      }
+    });
+
+    const root = wrapper.get(`[data-testid="item-card-${ id }"]`);
+
+    expect(root.attributes('role')).toBeUndefined();
+    expect(root.attributes('tabindex')).toBeUndefined();
+  });
+
+  it('supports keyboard enter to trigger click', async() => {
+    const wrapper = mount(RcItemCard, {
+      props: {
+        ...baseProps,
+        clickable: true
+      }
+    });
+
+    await wrapper.trigger('keydown.enter');
+    expect(wrapper.emitted('card-click')).toBeTruthy();
+  });
+
+  it('supports slot for footer and sub-header', () => {
+    const wrapper = mount(RcItemCard, {
+      props: baseProps,
+      slots: {
+        'item-card-footer':     '<div>FooterContent</div>',
+        'item-card-sub-header': '<div>SubHeaderContent</div>'
+      }
+    });
+
+    expect(wrapper.text()).toContain('FooterContent');
+    expect(wrapper.text()).toContain('SubHeaderContent');
+  });
+
+  it('renders icon with custom color', () => {
+    const wrapper = mount(RcItemCard, {
+      props: {
+        ...baseProps,
+        header: {
+          ...baseProps.header,
+          statuses: [
+            { icon: 'icon-custom', customColor: 'red' }
+          ]
+        }
+      }
+    });
+
+    const icon = wrapper.get('[data-testid="item-card-header-status-0"]');
+
+    expect(icon.attributes('style')).toContain('color: red');
+  });
+});

package/rancher-components/RcItemCard/RcItemCard.vue

@@ -0,0 +1,430 @@
+<script setup lang="ts">
+import { ref, computed } from 'vue';
+import { useStore } from 'vuex';
+import { useI18n } from '@shell/composables/useI18n';
+import LazyImage from '@shell/components/LazyImage.vue';
+import { DropdownOption } from '@components/RcDropdown/types';
+import ActionMenu from '@shell/components/ActionMenuShell.vue';
+
+const store = useStore();
+const { t } = useI18n(store);
+
+/**
+ * Variants available for ItemCard layout
+ */
+type RcItemCardVariant = 'small' | 'medium';
+
+/**
+ * A label that can be either plain text or a translatable key.
+ */
+type Label = {
+  key?: string;
+  text?: string;
+};
+
+/**
+ * Represents an image used in the card.
+ */
+type Image = {
+  src: string;
+  alt?: Label;
+};
+
+/**
+ * Optional pill badge, typically used to highlight a tag or state.
+ */
+type Pill = {
+  label: Label;
+  tooltip?: Label;
+};
+
+/**
+ * Represents an icon-based status indicator shown in the card header.
+ */
+type Status = {
+  icon: string;
+  color?: string;
+  customColor?: string;
+  tooltip?: Label;
+  handleClick?: () => void;
+};
+
+/**
+ * Header metadata for the card.
+ */
+type Header = {
+  title?: Label;
+  statuses?: Status[];
+};
+
+/**
+ * The generic data value passed to the card.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type ItemValue = Record<string, any>;
+
+/**
+ * Props accepted by the ItemCard component.
+ */
+interface RcItemCardProps {
+  /** Unique identifier for the card (used in test IDs) */
+  id: string;
+
+  /** Any object value associated with this card */
+  value: ItemValue;
+
+  /** Card title, status icons and action menu. Image will be included in the header in small variant too */
+  header: Header;
+
+  /** Optional image to show in card (position depends on variant). A slot is available for it too #item-card-image */
+  image?: Image;
+
+  /** Optional actions that will be displayed inside an action-menu */
+  actions?: DropdownOption[];
+
+  /** Text content inside the card body. A slot is available for it too #item-card-content */
+  content?: Label;
+
+  /** Layout variant: 'small' or 'medium' */
+  variant?: RcItemCardVariant;
+
+  /** Optional pill shown (only if variant is not 'small'). A slot is available for it too #item-card-pill */
+  pill?: Pill;
+
+  /** Makes the card clickable and emits 'card-click' on click/enter/space */
+  clickable?: boolean;
+}
+
+const props = defineProps<RcItemCardProps>();
+
+/**
+ * Emits 'card-click' when card is clicked or activated via keyboard.
+ */
+const emit = defineEmits<{( e: 'card-click', value: ItemValue): void; }>();
+
+/**
+ * Handles the card click while avoiding nested interactive elements
+ * By using RcItemCardAction.vue the 'item-card-action' attribute automatically gets added
+ * which then gets used to ignore 'card-click'
+ */
+function _handleCardClick(e: MouseEvent | KeyboardEvent) {
+  const interactiveSelector = '[item-card-action]';
+
+  // Prevent card click if the user clicks on an inner actionable element like repo, category, or tag
+  if ((e.target as HTMLElement).closest(interactiveSelector)) {
+    return;
+  }
+
+  emit('card-click', props.value);
+}
+
+/**
+ * Utility to resolve localized or plain text labels.
+ */
+function labelText(label?: Label): string {
+  return label?.key ? t(label.key) : label?.text ?? '';
+}
+
+/** ---------------- data ------------------ */
+const cardEl = ref<HTMLElement | null>(null);
+
+/** ---------------- Computed ------------------ */
+
+const headerTitle = computed(() => labelText(props.header.title));
+const imageAlt = computed(() => labelText(props.image?.alt));
+const pillLabel = computed(() => labelText(props.pill?.label));
+const pillTooltip = computed(() => labelText(props.pill?.tooltip));
+const contentText = computed(() => labelText(props.content));
+const statusTooltips = computed(() => props.header.statuses?.map((status) => labelText(status.tooltip)) || []);
+
+const cardMeta = computed(() => ({
+  ariaLabel: props.clickable ? t('itemCard.ariaLabel.clickable', { cardTitle: labelText(props.header.title) }) : undefined,
+  tabIndex:  props.clickable ? '0' : undefined,
+  role:      props.clickable ? 'button' : undefined
+}));
+
+</script>
+
+<template>
+  <div
+    ref="cardEl"
+    class="item-card"
+    :class="{
+      'clickable':
+        clickable
+    }"
+    :role="cardMeta.role"
+    :tabindex="cardMeta.tabIndex"
+    :aria-label="cardMeta.ariaLabel"
+    :data-testid="`item-card-${id}`"
+    @click="_handleCardClick"
+    @keydown.enter="_handleCardClick"
+    @keydown.space.prevent="_handleCardClick"
+  >
+    <div :class="['item-card-body', variant]">
+      <template v-if="variant !== 'small'">
+        <div>
+          <slot name="item-card-image">
+            <div
+              v-if="image"
+              :class="['item-card-image', variant]"
+              data-testid="item-card-image"
+            >
+              <LazyImage
+                :src="image.src"
+                :alt="imageAlt"
+                :style="{'width': '40px', 'height': '40px', 'object-fit': 'contain'}"
+              />
+            </div>
+          </slot>
+          <slot name="item-card-pill">
+            <div
+              v-if="pill"
+              v-clean-tooltip="pillTooltip"
+              class="item-card-pill"
+              data-testid="item-card-pill"
+            >
+              {{ pillLabel }}
+            </div>
+          </slot>
+        </div>
+      </template>
+
+      <div :class="['item-card-body-details', variant]">
+        <div :class="['item-card-header', variant]">
+          <div class="item-card-header-left">
+            <template v-if="variant === 'small'">
+              <slot name="item-card-image">
+                <div
+                  v-if="image"
+                  :class="['item-card-image', variant]"
+                  data-testid="item-card-image"
+                >
+                  <LazyImage
+                    :src="image.src"
+                    :alt="imageAlt"
+                    :style="{'width': '24px', 'height': '24px', 'object-fit': 'contain'}"
+                  />
+                </div>
+              </slot>
+            </template>
+            <slot name="item-card-header-title">
+              <h3
+                v-if="header.title"
+                v-clean-tooltip="headerTitle"
+                :class="['item-card-header-title', variant]"
+                data-testid="item-card-header-title"
+              >
+                {{ headerTitle }}
+              </h3>
+            </slot>
+          </div>
+          <div class="item-card-header-right">
+            <div
+              v-if="header.statuses?.length"
+              class="item-card-header-statuses"
+            >
+              <div
+                v-for="(status, i) in header.statuses"
+                :key="i"
+                class="item-card-header-statuses-status"
+                data-testid="item-card-header-statuses-status"
+              >
+                <i
+                  v-clean-tooltip="statusTooltips[i]"
+                  :class="['icon', status.icon, status.color]"
+                  :style="{color: status.customColor}"
+                  :data-testid="`item-card-header-status-${i}`"
+                />
+              </div>
+            </div>
+
+            <template v-if="$slots['item-card-actions']">
+              <div class="item-card-header-action-menu">
+                <slot name="item-card-actions" />
+              </div>
+            </template>
+            <template v-else-if="actions">
+              <div class="item-card-header-action-menu">
+                <ActionMenu
+                  data-testid="item-card-header-action-menu"
+                  :custom-actions="actions"
+                />
+              </div>
+            </template>
+          </div>
+        </div>
+
+        <slot name="item-card-sub-header" />
+
+        <template v-if="$slots['item-card-content']">
+          <slot name="item-card-content">
+            <div
+              class="item-card-content"
+              data-testid="item-card-content"
+            />
+          </slot>
+        </template>
+        <template v-else-if="content">
+          <div
+            class="item-card-content"
+            data-testid="item-card-content"
+          >
+            <p>{{ contentText }}</p>
+          </div>
+        </template>
+
+        <slot name="item-card-footer" />
+      </div>
+    </div>
+  </div>
+</template>
+
+<style scoped lang="scss">
+$image-medium-box-width: 48px;
+
+.item-card {
+  display: flex;
+  padding: 16px;
+  align-items: flex-start;
+  gap: var(--gap-lg);
+  border-radius: var(--border-radius-md);
+  border: 1px solid var(--border);
+  background: var(--body-bg);
+
+  &.clickable:hover {
+    border-color: var(--primary);
+  }
+
+  &:focus-visible {
+    @include focus-outline;
+    outline-offset: -2px;
+  }
+
+  &-image {
+    width: $image-medium-box-width;
+    height: $image-medium-box-width;
+    display: flex;
+    align-items: center;
+    justify-content: center;
+    background: #fff;
+    border-radius: var(--border-radius);
+
+    &.small {
+      width: 32px;
+      height: 32px;
+      margin-right: 12px;
+    }
+  }
+
+  &-header {
+    display: flex;
+    align-items: center;
+    justify-content: space-between;
+    width: 100%;
+    height: 24px;
+    color: var(--body-text);
+
+    &-left,
+    &-right {
+      display: flex;
+      align-items: center;
+    }
+
+    &-left {
+      flex-grow: 1;
+      min-width: 0;
+    }
+
+    &-title {
+      max-width: 80%;
+      font-size: 18px;
+      font-weight: 600;
+      margin-bottom: 0px;
+      line-height: 24px;
+      text-overflow: ellipsis;
+      white-space: nowrap;
+      overflow: hidden;
+    }
+
+    &-statuses {
+      display: flex;
+      align-items: flex-start;
+      gap: 12px;
+
+      &-status {
+        width: 24px;
+        height: 24px;
+        display: flex;
+        align-items: center;
+        justify-content: center;
+
+        .icon {
+          font-size: 23px;
+
+          &.error    { color: var(--error); }
+          &.info     { color: var(--info); }
+          &.success  { color: var(--success); }
+        }
+      }
+    }
+
+    &-action-menu {
+      margin-left: 12px;
+    }
+  }
+
+  &-content {
+    display: -webkit-box;
+    -webkit-line-clamp: 3;
+    -webkit-box-orient: vertical;
+    overflow: hidden;
+    text-overflow: ellipsis;
+    line-height: 21px;
+    word-break: break-word;
+  }
+
+  &-pill {
+    display: flex;
+    width: $image-medium-box-width;
+    padding: 4px 8px;
+    margin-top: 16px;
+    justify-content: center;
+    align-items: center;
+    border-radius: var(--border-radius);
+    background: var(--default);
+    text-transform: uppercase;
+    color: var(--disabled-text);
+    font-size: 10px;
+    font-weight: 600;
+  }
+
+  &-body {
+    display: flex;
+    flex-direction: row;
+    width: 100%;
+    gap: var(--gap-lg);
+
+    &.small {
+      flex-direction: column;
+      align-items: flex-start;
+      gap: var(--gap);
+      flex: 1;
+    }
+
+    &-details {
+      display: flex;
+      flex-direction: column;
+      align-items: flex-start;
+      width: calc(100% - var(--gap-lg) - $image-medium-box-width);
+      gap: var(--gap);
+      flex: 1;
+
+      &.small {
+        width: 100%;
+      }
+    }
+  }
+}
+
+</style>

package/rancher-components/RcItemCard/RcItemCardAction.vue

@@ -0,0 +1,24 @@
+<script setup lang="ts">
+/**
+ * RcItemCardAction
+ *
+ * This component is used to wrap any interactive elements (like buttons, links)
+ * inside an RcItemCard so they don't trigger the card-click event.
+ *
+ * Usage:
+ *
+ * <rc-item-card-action @click="doSomething">
+ *   <a href="#">Click me</a>
+ * </rc-item-card-action>
+ *
+ */
+</script>
+
+<template>
+  <div
+    item-card-action
+    data-testid="rc-item-card-action"
+  >
+    <slot />
+  </div>
+</template>

package/rancher-components/RcItemCard/index.ts

@@ -0,0 +1,2 @@
+export { default as RcItemCard } from './RcItemCard.vue';
+export { default as RcItemCardAction } from './RcItemCardAction.vue';

package/store/auth.js

@@ -14,6 +14,7 @@ export const BASE_SCOPES = {
   azuread:      [],
   keycloakoidc: ['openid profile email'],
   genericoidc:  ['openid profile email'],
+  cognito:      ['openid email'],
 };
 
 const KEY = 'rc_nonce';
@@ -355,6 +356,8 @@ export const actions = {
 
     commit('loggedOut');
     dispatch('onLogout', null, { root: true });
+
+    dispatch('uiplugins/setReady', false, { root: true });
   },
 
   async logout({ dispatch, getters, rootState }, options = {}) {