@adyen/bento-mcp 0.11.0 → 0.12.0

package/dist/assets/components/layout/components/layout-row/layout-row.vue

@@ -1 +1 @@
-<template> <bento-typography el="div" class="b-layout-row" :class="conditionalRowClass"> <div v-if="hasSlot('default')"> <slot /> </div> <div v-else-if="hasSlot('col-1') && hasSlot('col-2')" ref="row" :class="conditionalRowWithColumnsClass"> <div ref="col1" :class="conditionalColumnClass.col1"> <slot name="col-1"></slot> </div> <div ref="col2" :class="conditionalColumnClass.col2"> <slot name="col-2"></slot> </div> </div> </bento-typography> </template> <script setup lang="ts"> import { computed, inject, nextTick, onMounted, ref, type Ref, useSlots, watch } from 'vue'; import { BentoTypography } from '@/components/typography'; import { useHasSlot } from '@/composables'; import { BentoLayoutRowColumnLayoutOptions, type BentoLayoutRowProps, type BentoLayoutSize, } from '../../layout.types'; import { useMediaQuery } from '@vueuse/core'; import { LAYOUT_SIZE_INJECTION_KEY } from '@/components/layout/layout.keys'; const props = withDefaults(defineProps<BentoLayoutRowProps>(), { columnsLayout: '6-6', }); const slots = useSlots(); const hasSlot = useHasSlot(slots); const size = inject<Ref<BentoLayoutSize>>(LAYOUT_SIZE_INJECTION_KEY, ref('full-width')); const row = ref<HTMLElement>(null); const col1 = ref<HTMLElement>(null); const col2 = ref<HTMLElement>(null); const isFullWidth = computed(() => size.value === 'full-width'); const isValidColumnLayout = computed(() => BentoLayoutRowColumnLayoutOptions.includes(props.columnsLayout)); const conditionalRowClass = computed(() => `b-layout-row--${size.value}`); const conditionalRowWithColumnsClass = computed(() => ({ 'b-layout-row__column-wrapper': isFullWidth.value, })); const conditionalColumnClass = computed(() => { const columns = isValidColumnLayout.value ? props.columnsLayout.split('-') : [6, 6]; const getColumnModifier = index => (isFullWidth.value ? columns[index] : size.value); return { col1: `b-layout-row__column--${getColumnModifier(0)}`, col2: `b-layout-row__column--${getColumnModifier(1)}`, }; }); watch( useMediaQuery('(min-width: 768px)'), async isLargeScreen => { await nextTick(); const areColumnsInTheRightOrder = row.value?.firstChild === col1.value; if (isLargeScreen && !areColumnsInTheRightOrder) { row.value?.prepend(col1.value); } else if (!isLargeScreen && (props.columnsLayout === '3-9' || props.columnsLayout === '4-8')) { row.value?.prepend(col2.value); } }, { immediate: true } ); onMounted(() => { if (!isFullWidth.value && (hasSlot('col-1') || hasSlot('col-2'))) { throw new Error( 'Column slots can only be used with the `full-width` size. Please check documentation for more info.' ); } if (!isValidColumnLayout.value) { throw new Error( `${props.columnsLayout} is not a valid column layout. Please refer to the documentation for the list of available column layouts.` ); } }); </script> <script lang="ts"> /** * Page row is subcomponent of Layout meant to be used to generate the row layout. * * @example * import { BentoLayout, BentoLayoutRow } from '@adyen/bento-vue2'; * * export default { * components: { BentoLayout, BentoLayoutRow }, * template: ` * <bento-layout> * <bento-layout-row columns-layout="3-9"> * <template #col-1>Narrow 3-9</template> * <template #col-2>Wide 3-9</template> * </bento-layout-row> * <bento-layout-row> * <template #col-1>6-6</template> * <template #col-2>6-6</template> * </bento-layout-row> * </bento-layout> * ` * } */ export default {}; </script> <style lang="scss" scoped src="./layout-row.scss" /> 
+<template> <bento-typography el="div" class="b-layout-row" :class="conditionalRowClass"> <div v-if="hasSlot('default')" class="b-layout-row__wrapper"> <slot /> </div> <div v-else-if="hasSlot('col-1') && hasSlot('col-2')" ref="row" :class="conditionalRowWithColumnsClass"> <div ref="col1" :class="conditionalColumnClass.col1"> <slot name="col-1"></slot> </div> <div ref="col2" :class="conditionalColumnClass.col2"> <slot name="col-2"></slot> </div> </div> </bento-typography> </template> <script setup lang="ts"> import { computed, inject, nextTick, onMounted, ref, type Ref, useSlots, watch } from 'vue'; import { BentoTypography } from '@/components/typography'; import { useHasSlot } from '@/composables'; import { BentoLayoutRowColumnLayoutOptions } from '../../layout.internal.types'; import { type BentoLayoutRowProps, type BentoLayoutSize } from '../../layout.types'; import { useMediaQuery } from '@vueuse/core'; import { LAYOUT_SIZE_INJECTION_KEY } from '@/components/layout/layout.keys'; const props = withDefaults(defineProps<BentoLayoutRowProps>(), { columnsLayout: '6-6', fullHeight: false, }); const slots = useSlots(); const hasSlot = useHasSlot(slots); const size = inject<Ref<BentoLayoutSize>>(LAYOUT_SIZE_INJECTION_KEY, ref('full-width')); const row = ref<HTMLElement>(null); const col1 = ref<HTMLElement>(null); const col2 = ref<HTMLElement>(null); const isFullWidth = computed(() => size.value === 'full-width'); const isValidColumnLayout = computed(() => BentoLayoutRowColumnLayoutOptions.includes(props.columnsLayout)); const conditionalRowClass = computed(() => ({ [`b-layout-row--${size.value}`]: true, 'b-layout-row--full-height': props.fullHeight, })); const conditionalRowWithColumnsClass = computed(() => ({ 'b-layout-row__column-wrapper': isFullWidth.value, })); const conditionalColumnClass = computed(() => { const columns = isValidColumnLayout.value ? props.columnsLayout.split('-') : [6, 6]; const getColumnModifier = index => (isFullWidth.value ? columns[index] : size.value); return { col1: `b-layout-row__column--${getColumnModifier(0)}`, col2: `b-layout-row__column--${getColumnModifier(1)}`, }; }); watch( useMediaQuery('(min-width: 768px)'), async isLargeScreen => { await nextTick(); const areColumnsInTheRightOrder = row.value?.firstChild === col1.value; if (isLargeScreen && !areColumnsInTheRightOrder) { row.value?.prepend(col1.value); } else if (!isLargeScreen && (props.columnsLayout === '3-9' || props.columnsLayout === '4-8')) { row.value?.prepend(col2.value); } }, { immediate: true } ); onMounted(() => { if (!isFullWidth.value && (hasSlot('col-1') || hasSlot('col-2'))) { throw new Error( 'Column slots can only be used with the `full-width` size. Please check documentation for more info.' ); } if (!isValidColumnLayout.value) { throw new Error( `${props.columnsLayout} is not a valid column layout. Please refer to the documentation for the list of available column layouts.` ); } }); </script> <script lang="ts"> /** * Page row is subcomponent of Layout meant to be used to generate the row layout. * * @example * import { BentoLayout, BentoLayoutRow } from '@adyen/bento-vue2'; * * export default { * components: { BentoLayout, BentoLayoutRow }, * template: ` * <bento-layout> * <bento-layout-row columns-layout="3-9"> * <template #col-1>Narrow 3-9</template> * <template #col-2>Wide 3-9</template> * </bento-layout-row> * <bento-layout-row> * <template #col-1>6-6</template> * <template #col-2>6-6</template> * </bento-layout-row> * </bento-layout> * ` * } */ export default {}; </script> <style lang="scss" scoped src="./layout-row.scss" /> 

package/dist/assets/components/layout/layout.docs.mdx

@@ -1,5 +1,6 @@
 import { Canvas, Meta } from '@storybook/blocks';
 import * as Layout from './layout.stories';
+import * as LayoutRow from './components/layout-row/layout-row.stories';
 
 <Meta of={Layout} />
 
@@ -77,6 +78,15 @@ As mentioned above, there are five layouts available: `6-6`, `3-9`, `9-3`, `4-8`
 Breaking up the content into two columns only works when using the `full-width` size. If you're using the `narrow` or
 `half-width` size, or passing the content in the `default` slot, the content will always span 12 columns.
 
+## Full height
+
+Use the `full-height` prop on `bento-layout-row` when the row should fill the remaining height of a parent layout. The
+parent layout needs an explicit height and a grid row that can grow, such as `grid-template-rows: auto minmax(0, 1fr)`.
+
+This is useful for content such as a Data Grid with `fit-content` and `sticky-pagination`.
+
+<Canvas of={LayoutRow.FullHeight} />
+
 ## Nested
 
 It is possible to nest rows within rows and even layout inside of a row, but this should be avoided as much as possible,

package/dist/assets/components/layout/layout.internal.types.ts

@@ -0,0 +1 @@
+export const BentoLayoutVariantOptions = ['page', 'component'] as const; export const BentoLayoutSizeOptions = ['full-width', 'narrow', 'half-width'] as const; export const BentoLayoutRowColumnLayoutOptions = ['3-9', '9-3', '4-8', '8-4', '6-6'] as const; 

package/dist/assets/components/layout/layout.stories.ts

@@ -1 +1 @@
-import { computed } from 'vue'; import { isVue2 } from 'vue-demi'; import { storybookDocsParameter } from '@/utils/ts/storybook'; import type { Meta, StoryObj } from '@storybook/vue'; import { BentoLayout, BentoLayoutRow } from '@/components/layout'; import { BentoLayoutSizeOptions, BentoLayoutVariantOptions } from '@/components/layout/layout.types'; import './layout.stories.scss?module'; const meta: Meta = { title: 'Layout', component: BentoLayout, argTypes: { variant: { options: BentoLayoutVariantOptions, control: { type: 'select', }, }, size: { options: BentoLayoutSizeOptions, control: { type: 'select', }, }, }, parameters: { layout: 'fullscreen', }, }; export default meta; type Story = StoryObj<typeof BentoLayout>; const defaultCode = ` <template> <bento-layout size="half-width"> <bento-layout-row>Row 1</bento-layout-row> <bento-layout-row>Row 2</bento-layout-row> <bento-layout-row>Row 3</bento-layout-row> </bento-layout> </template> <script setup lang="ts"></script> `; export const Default: Story = { render: (_args, { argTypes }) => ({ components: { BentoLayout, BentoLayoutRow, }, props: Object.keys(argTypes), template: ` <bento-layout v-bind="args"> <bento-layout-row class="b-layout-story__row"> <div>Page header</div> <div>{{ numberCols}} cols</div> </bento-layout-row> <bento-layout-row class="b-layout-story__row b-layout-story__row--content"> <div>Content</div> <div>{{ numberCols}} cols</div> </bento-layout-row> </bento-layout> `, setup(props) { const args = isVue2 ? props : _args; const colsMap = Object.freeze({ ['half-width']: 6, ['narrow']: 8, ['full-width']: 12, }); const numberCols = computed(() => colsMap[args.size]); return { args, numberCols, }; }, }), args: { size: 'half-width' }, parameters: storybookDocsParameter(defaultCode), }; const withColumnsCode = ` <template> <bento-layout size="full-width"> <bento-layout-row columns-layout="3-9"> <template #col-1>Narrow 3-9</template> <template #col-2>Wide 3-9</template> </bento-layout-row> <bento-layout-row columns-layout="4-8"> <template #col-1>Narrow 4-8</template> <template #col-2>Wide 4-8</template> </bento-layout-row> <bento-layout-row columns-layout="9-3"> <template #col-1>Wide 9-3</template> <template #col-2>Narrow 9-3</template> </bento-layout-row> <bento-layout-row columns-layout="8-4"> <template #col-1>Wide 8-4</template> <template #col-2>Narrow 8-4</template> </bento-layout-row> <bento-layout-row> <template #col-1>6-6</template> <template #col-2>6-6</template> </bento-layout-row> </bento-layout> </template> `; export const WithColumns: Story = { render: (_args, { argTypes }) => ({ components: { BentoLayout, BentoLayoutRow, }, props: Object.keys(argTypes), template: ` <bento-layout v-bind="args"> <bento-layout-row class="b-layout-story__row b-layout-story__row--thin">12 cols</bento-layout-row> <bento-layout-row columns-layout="3-9" class="b-layout-story__row-with-cells"> <template #col-1><div class="b-layout-story__cell">3 cols</div></template> <template #col-2><div class="b-layout-story__cell">9 cols</div></template> </bento-layout-row> <bento-layout-row columns-layout="9-3" class="b-layout-story__row-with-cells"> <template #col-1><div class="b-layout-story__cell">9 cols</div></template> <template #col-2><div class="b-layout-story__cell">3 cols</div></template> </bento-layout-row> <bento-layout-row columns-layout="4-8" class="b-layout-story__row-with-cells"> <template #col-1><div class="b-layout-story__cell">4 cols</div></template> <template #col-2><div class="b-layout-story__cell">8 cols</div></template> </bento-layout-row> <bento-layout-row columns-layout="8-4" class="b-layout-story__row-with-cells"> <template #col-1><div class="b-layout-story__cell">8 cols</div></template> <template #col-2><div class="b-layout-story__cell">4 cols</div></template> </bento-layout-row> <bento-layout-row columns-layout="6-6" class="b-layout-story__row-with-cells"> <template #col-1><div class="b-layout-story__cell">6 cols</div></template> <template #col-2><div class="b-layout-story__cell">6 cols</div></template> </bento-layout-row> </bento-layout> `, setup(props) { const args = isVue2 ? props : _args; return { args, }; }, }), args: { size: 'full-width' }, parameters: storybookDocsParameter(withColumnsCode), }; const nestedCode = ` <template> <bento-layout variant="page" size="full-width"> <bento-layout-row>Single column row</bento-layout-row> <bento-layout-row columns-layout="3-9"> <template #col-1>Col 1</template> <template #col-2> <bento-layout-row columns-layout="4-8"> <template #col-1>Col 2.1 (nested)</template> <template #col-2>Col 2.2 (nested)</template> </bento-layout-row> </template> </bento-layout-row> <bento-layout-row columns-layout="9-3" class="b-layout-story__row-with-cells"> <template #col-1> <bento-layout-row columns-layout="8-4"> <template #col-1>Col 1.1 (nested)</template> <template #col-2>Col 1.2 (nested)</template> </bento-layout-row> </template> <template #col-2>Col 2</template> </bento-layout-row> <bento-layout-row columns-layout="3-9"> <bento-layout size="full-width" variant="component"> <bento-layout-row>Row with nested Layout</bento-layout-row> </bento-layout> </bento-layout-row> </bento-layout> </template> `; export const Nested: Story = { render: (_args, { argTypes }) => ({ components: { BentoLayout, BentoLayoutRow, }, props: Object.keys(argTypes), template: ` <bento-layout v-bind="args"> <bento-layout-row class="b-layout-story__row b-layout-story__row--thin">Single column row</bento-layout-row> <bento-layout-row columns-layout="3-9" class="b-layout-story__row-with-cells"> <template #col-1><div class="b-layout-story__cell">Col 1</div></template> <template #col-2> <bento-layout-row columns-layout="4-8"> <template #col-1><div class="b-layout-story__cell">Col 2.1 (nested)</div></template> <template #col-2><div class="b-layout-story__cell">Col 2.2 (nested)</div></template> </bento-layout-row> </template> </bento-layout-row> <bento-layout-row columns-layout="9-3" class="b-layout-story__row-with-cells"> <template #col-1> <bento-layout-row columns-layout="8-4"> <template #col-1><div class="b-layout-story__cell">Col 1.1 (nested)</div></template> <template #col-2><div class="b-layout-story__cell">Col 1.2 (nested)</div></template> </bento-layout-row> </template> <template #col-2><div class="b-layout-story__cell">Col 2</div></template> </bento-layout-row> <bento-layout-row columns-layout="3-9" class="b-layout-story__row-with-cells"> <bento-layout size="full-width" variant="component"> <bento-layout-row class="b-layout-story__cell">Row with nested Layout</bento-layout-row> </bento-layout> </bento-layout-row> </bento-layout> `, setup(props) { const args = isVue2 ? props : _args; return { args, }; }, }), args: { size: 'full-width' }, parameters: storybookDocsParameter(nestedCode), }; 
+import { computed } from 'vue'; import { isVue2 } from 'vue-demi'; import { storybookDocsParameter } from '@/utils/ts/storybook'; import type { Meta, StoryObj } from '@storybook/vue'; import { BentoLayout, BentoLayoutRow } from '@/components/layout'; import { BentoLayoutSizeOptions, BentoLayoutVariantOptions } from '@/components/layout/layout.internal.types'; const LayoutDefaultExample = "<template>\n <bento-layout size=\"half-width\">\n <bento-layout-row>\n <div>Page header</div>\n <div>6 cols</div>\n </bento-layout-row>\n <bento-layout-row>\n <div>Content</div>\n <div>6 cols</div>\n </bento-layout-row>\n </bento-layout>\n</template>\n\n<script setup lang=\"ts\">\n import { BentoLayout, BentoLayoutRow } from '@adyen/bento-vue2';\n</script>\n"; const LayoutNestedExample = "<template>\n <bento-layout variant=\"page\" size=\"full-width\">\n <bento-layout-row>Single column row</bento-layout-row>\n <bento-layout-row columns-layout=\"3-9\">\n <template #col-1>Col 1</template>\n <template #col-2>\n <bento-layout-row columns-layout=\"4-8\">\n <template #col-1>Col 2.1 (nested)</template>\n <template #col-2>Col 2.2 (nested)</template>\n </bento-layout-row>\n </template>\n </bento-layout-row>\n <bento-layout-row columns-layout=\"9-3\">\n <template #col-1>\n <bento-layout-row columns-layout=\"8-4\">\n <template #col-1>Col 1.1 (nested)</template>\n <template #col-2>Col 1.2 (nested)</template>\n </bento-layout-row>\n </template>\n <template #col-2>Col 2</template>\n </bento-layout-row>\n <bento-layout-row columns-layout=\"3-9\">\n <bento-layout size=\"full-width\" variant=\"component\">\n <bento-layout-row>Row with nested Layout</bento-layout-row>\n </bento-layout>\n </bento-layout-row>\n </bento-layout>\n</template>\n\n<script setup lang=\"ts\">\n import { BentoLayout, BentoLayoutRow } from '@adyen/bento-vue2';\n</script>\n"; const LayoutWithColumnsExample = "<template>\n <bento-layout size=\"full-width\">\n <bento-layout-row>12 cols</bento-layout-row>\n <bento-layout-row columns-layout=\"3-9\">\n <template #col-1>3 cols</template>\n <template #col-2>9 cols</template>\n </bento-layout-row>\n <bento-layout-row columns-layout=\"9-3\">\n <template #col-1>9 cols</template>\n <template #col-2>3 cols</template>\n </bento-layout-row>\n <bento-layout-row columns-layout=\"4-8\">\n <template #col-1>4 cols</template>\n <template #col-2>8 cols</template>\n </bento-layout-row>\n <bento-layout-row columns-layout=\"8-4\">\n <template #col-1>8 cols</template>\n <template #col-2>4 cols</template>\n </bento-layout-row>\n <bento-layout-row columns-layout=\"6-6\">\n <template #col-1>6 cols</template>\n <template #col-2>6 cols</template>\n </bento-layout-row>\n </bento-layout>\n</template>\n\n<script setup lang=\"ts\">\n import { BentoLayout, BentoLayoutRow } from '@adyen/bento-vue2';\n</script>\n"; import './layout.stories.scss?module'; const meta: Meta = { title: 'Layout', component: BentoLayout, argTypes: { variant: { options: BentoLayoutVariantOptions, control: { type: 'select', }, }, size: { options: BentoLayoutSizeOptions, control: { type: 'select', }, }, }, parameters: { layout: 'fullscreen', }, }; export default meta; type Story = StoryObj<typeof BentoLayout>; export const Default: Story = { render: (_args, { argTypes }) => ({ components: { BentoLayout, BentoLayoutRow, }, props: Object.keys(argTypes), template: ` <bento-layout v-bind="args"> <bento-layout-row class="b-layout-story__row"> <div>Page header</div> <div>{{ numberCols}} cols</div> </bento-layout-row> <bento-layout-row class="b-layout-story__row b-layout-story__row--content"> <div>Content</div> <div>{{ numberCols}} cols</div> </bento-layout-row> </bento-layout> `, setup(props) { const args = isVue2 ? props : _args; const colsMap = Object.freeze({ ['half-width']: 6, ['narrow']: 8, ['full-width']: 12, }); const numberCols = computed(() => colsMap[args.size]); return { args, numberCols, }; }, }), args: { size: 'half-width' }, parameters: storybookDocsParameter(LayoutDefaultExample), }; export const WithColumns: Story = { render: (_args, { argTypes }) => ({ components: { BentoLayout, BentoLayoutRow, }, props: Object.keys(argTypes), template: ` <bento-layout v-bind="args"> <bento-layout-row class="b-layout-story__row b-layout-story__row--thin">12 cols</bento-layout-row> <bento-layout-row columns-layout="3-9" class="b-layout-story__row-with-cells"> <template #col-1><div class="b-layout-story__cell">3 cols</div></template> <template #col-2><div class="b-layout-story__cell">9 cols</div></template> </bento-layout-row> <bento-layout-row columns-layout="9-3" class="b-layout-story__row-with-cells"> <template #col-1><div class="b-layout-story__cell">9 cols</div></template> <template #col-2><div class="b-layout-story__cell">3 cols</div></template> </bento-layout-row> <bento-layout-row columns-layout="4-8" class="b-layout-story__row-with-cells"> <template #col-1><div class="b-layout-story__cell">4 cols</div></template> <template #col-2><div class="b-layout-story__cell">8 cols</div></template> </bento-layout-row> <bento-layout-row columns-layout="8-4" class="b-layout-story__row-with-cells"> <template #col-1><div class="b-layout-story__cell">8 cols</div></template> <template #col-2><div class="b-layout-story__cell">4 cols</div></template> </bento-layout-row> <bento-layout-row columns-layout="6-6" class="b-layout-story__row-with-cells"> <template #col-1><div class="b-layout-story__cell">6 cols</div></template> <template #col-2><div class="b-layout-story__cell">6 cols</div></template> </bento-layout-row> </bento-layout> `, setup(props) { const args = isVue2 ? props : _args; return { args, }; }, }), args: { size: 'full-width' }, parameters: storybookDocsParameter(LayoutWithColumnsExample), }; export const Nested: Story = { render: (_args, { argTypes }) => ({ components: { BentoLayout, BentoLayoutRow, }, props: Object.keys(argTypes), template: ` <bento-layout v-bind="args"> <bento-layout-row class="b-layout-story__row b-layout-story__row--thin">Single column row</bento-layout-row> <bento-layout-row columns-layout="3-9" class="b-layout-story__row-with-cells"> <template #col-1><div class="b-layout-story__cell">Col 1</div></template> <template #col-2> <bento-layout-row columns-layout="4-8"> <template #col-1><div class="b-layout-story__cell">Col 2.1 (nested)</div></template> <template #col-2><div class="b-layout-story__cell">Col 2.2 (nested)</div></template> </bento-layout-row> </template> </bento-layout-row> <bento-layout-row columns-layout="9-3" class="b-layout-story__row-with-cells"> <template #col-1> <bento-layout-row columns-layout="8-4"> <template #col-1><div class="b-layout-story__cell">Col 1.1 (nested)</div></template> <template #col-2><div class="b-layout-story__cell">Col 1.2 (nested)</div></template> </bento-layout-row> </template> <template #col-2><div class="b-layout-story__cell">Col 2</div></template> </bento-layout-row> <bento-layout-row columns-layout="3-9" class="b-layout-story__row-with-cells"> <bento-layout size="full-width" variant="component"> <bento-layout-row class="b-layout-story__cell">Row with nested Layout</bento-layout-row> </bento-layout> </bento-layout-row> </bento-layout> `, setup(props) { const args = isVue2 ? props : _args; return { args, }; }, }), args: { size: 'full-width' }, parameters: storybookDocsParameter(LayoutNestedExample), }; 

package/dist/assets/components/layout/layout.types.ts

@@ -1 +1 @@
-/** * @private */ export const BentoLayoutVariantOptions = ['page', 'component'] as const; export const BentoLayoutSizeOptions = ['full-width', 'narrow', 'half-width'] as const; export const BentoLayoutRowColumnLayoutOptions = ['3-9', '9-3', '4-8', '8-4', '6-6'] as const; // Public export type BentoLayoutVariant = (typeof BentoLayoutVariantOptions)[number]; export type BentoLayoutSize = (typeof BentoLayoutSizeOptions)[number]; export type BentoLayoutRowColumnLayout = (typeof BentoLayoutRowColumnLayoutOptions)[number]; export interface BentoLayoutProps { /** Defines if the layout is used in a page or only a section */ variant?: BentoLayoutVariant; /** Defines the size of the page */ size?: BentoLayoutSize; } export interface BentoLayoutRowProps { /** Sets the layout of the columns when multiple columns are used */ columnsLayout?: BentoLayoutRowColumnLayout; } 
+import type { BentoLayoutRowColumnLayoutOptions, BentoLayoutSizeOptions, BentoLayoutVariantOptions, } from './layout.internal.types'; export type BentoLayoutVariant = (typeof BentoLayoutVariantOptions)[number]; export type BentoLayoutSize = (typeof BentoLayoutSizeOptions)[number]; export type BentoLayoutRowColumnLayout = (typeof BentoLayoutRowColumnLayoutOptions)[number]; export interface BentoLayoutProps { /** Defines if the layout is used in a page or only a section */ variant?: BentoLayoutVariant; /** Defines the size of the page */ size?: BentoLayoutSize; } export interface BentoLayoutRowProps { /** Sets the layout of the columns when multiple columns are used */ columnsLayout?: BentoLayoutRowColumnLayout; /** Makes the row's slot content fill its available height */ fullHeight?: boolean; } 

package/dist/assets/components/link/link.stories.ts

@@ -1 +1 @@
-import BentoLink from './link.vue'; import { BentoTypography } from '@/components/typography'; import { BentoLinkVariant } from './link.types'; import { storybookDocsParameter } from '@/utils/ts/storybook'; import { type Meta, type StoryObj } from '@storybook/vue'; import { isVue2 } from 'vue-demi'; const meta: Meta<typeof BentoLink> = { title: 'Link', component: BentoLink, argTypes: { // Slots default: { name: 'default', defaultValue: '', description: 'link text', table: { type: { summary: 'VNode[]' }, }, control: { type: 'text', }, }, // Router props to: { name: 'to', defaultValue: '/', description: 'Denotes the target route of the link. When clicked, the value of the `to` prop will be passed to `router.push()` internally, so the value can be either a string or a location descriptor object.', table: { type: { summary: 'string | Location' }, }, control: { type: 'text', }, }, // Custom props variant: { options: Object.values(BentoLinkVariant), mapping: BentoLinkVariant, control: { type: 'select', }, }, target: { name: 'target', defaultValue: null, control: { type: 'text', }, }, // Emits click: { name: 'click', defaultValue: '', description: 'Click event handler.', table: { type: { summary: '($event) => void' }, }, control: { disable: true }, }, // TODO: remove this when Vue fixes extending interface issue for defineProps args: { table: { disable: true } }, }, }; export default meta; type Story = StoryObj<typeof BentoLink>; const DEFFAULT_ARGS = { to: '/', }; const EXTERNAL_HREF = 'https://www.adyen.com/'; // Default export const Default: Story = { render: (_args, { argTypes }) => ({ components: { BentoLink, BentoTypography }, props: Object.keys(argTypes), template: ` <div> <bento-typography> <bento-link v-bind="args"> an interactive link </bento-link> </bento-typography> </div> `, setup: props => ({ args: isVue2 ? props : _args }), }), args: DEFFAULT_ARGS, parameters: storybookDocsParameter(` <bento-typography> <bento-link to="router/path"> an interactive link </bento-link> </bento-typography> `), }; // Quiet export const Quiet: Story = { ...Default, args: { ...DEFFAULT_ARGS, variant: 'quiet', }, parameters: storybookDocsParameter(` <bento-typography> <bento-link variant="quiet" to="router/path"> an interactive link </bento-link> </bento-typography> `), }; // External export const External: Story = { ...Default, args: { ...DEFFAULT_ARGS, external: true, to: EXTERNAL_HREF, }, parameters: storybookDocsParameter(` <bento-typography> <bento-link to="${EXTERNAL_HREF}" external> an interactive link </bento-link> </bento-typography> `), }; // isNotRouting export const isNotRouting: Story = { ...Default, args: { ...DEFFAULT_ARGS, isNotRouting: true, }, parameters: storybookDocsParameter(` <bento-typography> <bento-link to="link/path" is-not-routing> an interactive link </bento-link> </bento-typography> `), }; 
+import BentoLink from './link.vue'; import { BentoTypography } from '@/components/typography'; import { BentoLinkVariant } from './link.types'; import { storybookDocsParameter } from '@/utils/ts/storybook'; import { type Meta, type StoryObj } from '@storybook/vue'; import { isVue2 } from 'vue-demi'; const LinkDefaultExample = "<template>\n <bento-typography>\n <bento-link to=\"/\">an interactive link</bento-link>\n </bento-typography>\n</template>\n\n<script setup lang=\"ts\">\n import { BentoLink, BentoTypography } from '@adyen/bento-vue2';\n</script>\n"; const LinkExternalExample = "<template>\n <bento-typography>\n <bento-link to=\"https://www.adyen.com/\" external>an interactive link</bento-link>\n </bento-typography>\n</template>\n\n<script setup lang=\"ts\">\n import { BentoLink, BentoTypography } from '@adyen/bento-vue2';\n</script>\n"; const LinkIsNotRoutingExample = "<template>\n <bento-typography>\n <bento-link to=\"/\" is-not-routing>an interactive link</bento-link>\n </bento-typography>\n</template>\n\n<script setup lang=\"ts\">\n import { BentoLink, BentoTypography } from '@adyen/bento-vue2';\n</script>\n"; const LinkQuietExample = "<template>\n <bento-typography>\n <bento-link variant=\"quiet\" to=\"/\">an interactive link</bento-link>\n </bento-typography>\n</template>\n\n<script setup lang=\"ts\">\n import { BentoLink, BentoTypography } from '@adyen/bento-vue2';\n</script>\n"; const meta: Meta<typeof BentoLink> = { title: 'Link', component: BentoLink, argTypes: { // Slots default: { name: 'default', defaultValue: '', description: 'link text', table: { type: { summary: 'VNode[]' }, }, control: { type: 'text', }, }, // Router props to: { name: 'to', defaultValue: '/', description: 'Denotes the target route of the link. When clicked, the value of the `to` prop will be passed to `router.push()` internally, so the value can be either a string or a location descriptor object.', table: { type: { summary: 'string | Location' }, }, control: { type: 'text', }, }, // Custom props variant: { options: Object.values(BentoLinkVariant), mapping: BentoLinkVariant, control: { type: 'select', }, }, target: { name: 'target', defaultValue: null, control: { type: 'text', }, }, // Emits click: { name: 'click', defaultValue: '', description: 'Click event handler.', table: { type: { summary: '($event) => void' }, }, control: { disable: true }, }, // TODO: remove this when Vue fixes extending interface issue for defineProps args: { table: { disable: true } }, }, }; export default meta; type Story = StoryObj<typeof BentoLink>; const DEFFAULT_ARGS = { to: '/', }; const EXTERNAL_HREF = 'https://www.adyen.com/'; // Default export const Default: Story = { render: (_args, { argTypes }) => ({ components: { BentoLink, BentoTypography }, props: Object.keys(argTypes), template: ` <div> <bento-typography> <bento-link v-bind="args"> an interactive link </bento-link> </bento-typography> </div> `, setup: props => ({ args: isVue2 ? props : _args }), }), args: DEFFAULT_ARGS, parameters: storybookDocsParameter(LinkDefaultExample), }; // Quiet export const Quiet: Story = { ...Default, args: { ...DEFFAULT_ARGS, variant: 'quiet', }, parameters: storybookDocsParameter(LinkQuietExample), }; // External export const External: Story = { ...Default, args: { ...DEFFAULT_ARGS, external: true, to: EXTERNAL_HREF, }, parameters: storybookDocsParameter(LinkExternalExample), }; // isNotRouting export const isNotRouting: Story = { ...Default, args: { ...DEFFAULT_ARGS, isNotRouting: true, }, parameters: storybookDocsParameter(LinkIsNotRoutingExample), }; 

package/dist/assets/components/link/link.types.ts

@@ -1 +1 @@
-import type { Location } from 'vue-router/types/router.d.ts'; // TODO: revert to import once fully migrated to Vue 3 // import type { RouterLinkProps } from 'vue-router/types/router.d.ts'; /** * Manually defined RouterLinkProps to ensure compatibility * with Vue Macros and Vue 2.7 / 3 monorepos. */ export interface RouterLinkProps { /** * Denotes the target route of the link. When clicked, the value of the `to` prop will be passed to * `router.push()` internally, so the value can be either a string or a location descriptor object. */ to: string | Location; /** * Setting `replace` prop will call `router.replace()` instead of `router.push()` when clicked, so the navigation will * not create a new history record. * * @default false */ replace?: boolean; /** * Setting `append` prop always appends the relative path to the current path. For example, assuming we are navigating * from `/a` to a relative link `b`, without `append` we will end up at `/b`, but with append we will end up at * `/a/b`. * * @default false */ append?: boolean; /** * Sometimes we want <RouterLink> to render as another tag, e.g <li>. Then we can use tag prop to specify which tag to * render to, and it will still listen to click events for navigation. * * @default "a" */ tag?: string; /** * Configure the active CSS class applied when the link is active. Note the default value can also be configured * globally via the `linkActiveClass` router constructor option. * * @default "router-link-active" */ activeClass?: string; /** * The default active class matching behavior is **inclusive match**. For example, `<RouterLink to="/a">` will get * this class applied as long as the current path starts with `/a/` or is `/a`. * * @default false */ exact?: boolean; /** * Allows matching only using the `path` section of the url, effectively ignoring the `query` and the `hash` sections. * * @default false */ exactPath?: boolean; /** * Configure the active CSS class applied when the link is active with exact path match. Note the default value can * also be configured globally via the `linkExactPathActiveClass` router constructor option. * * @default "router-link-exact-path-active" */ exactPathActiveClass?: string; /** * Specify the event(s) that can trigger the link navigation. * * @default 'click' */ event?: string | ReadonlyArray<string>; /** * Configure the active CSS class applied when the link is active with exact match. Note the default value can also be * configured globally via the `linkExactActiveClass` router constructor option. * * @default "router-link-exact-active" */ exactActiveClass?: string; /** * Configure the value of `aria-current` when the link is active with exact match. It must be one of the allowed * values for [aria-current](https://www.w3.org/TR/wai-aria-1.2/#aria-current) in the ARIA spec. In most cases, the * default of page should be the best fit. * * @default "page" */ ariaCurrentValue?: 'page' | 'step' | 'location' | 'date' | 'time' | 'true' | 'false'; } /** * @deprecated Since v2.0.0. Use string literal instead. */ export enum BentoLinkVariant { DEFAULT = 'default', QUIET = 'quiet', } export type BentoLinkProps = RouterLinkProps & { /** * Disable the default typography for the component. Only use this when the component is inside another typography component. */ disableTypography?: boolean; /** * Set the rendered link to a regular external anchor link and renders an external link icon. */ external?: boolean; /** * Set to true if used inside a `BentoButton` component. */ isButton?: boolean; /** * Set the rendered link to a regular external anchor link. */ isNotRouting?: boolean; /** * Sets the target of the rendered link. */ target?: string; /** * Set to true to truncate link. Doesn't work with disableTypography. */ truncate?: boolean; /** * Link variant type affecting visual style. * @values default, quiet */ variant?: BentoLinkVariant | `${BentoLinkVariant}`; }; 
+import type { Location } from 'vue-router/types/router.d.ts'; // TODO: revert to import once fully migrated to Vue 3 // import type { RouterLinkProps } from 'vue-router/types/router.d.ts'; /** * Manually defined RouterLinkProps to ensure compatibility * with Vue Macros and Vue 2.7 / 3 monorepos. */ export interface RouterLinkProps { /** * Denotes the target route of the link. When clicked, the value of the `to` prop will be passed to * `router.push()` internally, so the value can be either a string or a location descriptor object. */ to: string | Location; /** * Setting `replace` prop will call `router.replace()` instead of `router.push()` when clicked, so the navigation will * not create a new history record. * * @default false */ replace?: boolean; /** * Setting `append` prop always appends the relative path to the current path. For example, assuming we are navigating * from `/a` to a relative link `b`, without `append` we will end up at `/b`, but with append we will end up at * `/a/b`. * * @default false */ append?: boolean; /** * Sometimes we want <RouterLink> to render as another tag, e.g <li>. Then we can use tag prop to specify which tag to * render to, and it will still listen to click events for navigation. * * @default "a" */ tag?: string; /** * Configure the active CSS class applied when the link is active. Note the default value can also be configured * globally via the `linkActiveClass` router constructor option. * * @default "router-link-active" */ activeClass?: string; /** * The default active class matching behavior is **inclusive match**. For example, `<RouterLink to="/a">` will get * this class applied as long as the current path starts with `/a/` or is `/a`. * * @default false */ exact?: boolean; /** * Allows matching only using the `path` section of the url, effectively ignoring the `query` and the `hash` sections. * * @default false */ exactPath?: boolean; /** * Configure the active CSS class applied when the link is active with exact path match. Note the default value can * also be configured globally via the `linkExactPathActiveClass` router constructor option. * * @default "router-link-exact-path-active" */ exactPathActiveClass?: string; /** * Specify the event(s) that can trigger the link navigation. * * @default 'click' */ event?: string | ReadonlyArray<string>; /** * Configure the active CSS class applied when the link is active with exact match. Note the default value can also be * configured globally via the `linkExactActiveClass` router constructor option. * * @default "router-link-exact-active" */ exactActiveClass?: string; /** * Configure the value of `aria-current` when the link is active with exact match. It must be one of the allowed * values for [aria-current](https://www.w3.org/TR/wai-aria-1.2/#aria-current) in the ARIA spec. In most cases, the * default of page should be the best fit. * * @default "page" */ ariaCurrentValue?: 'page' | 'step' | 'location' | 'date' | 'time' | 'true' | 'false'; } /** * @deprecated Since v3.0.0. Use string literal instead. */ export enum BentoLinkVariant { DEFAULT = 'default', QUIET = 'quiet', } export interface LinkProps { /** * Disable the default typography for the component. Only use this when the component is inside another typography component. */ disableTypography?: boolean; /** * Set the rendered link to a regular external anchor link and renders an external link icon. */ external?: boolean; /** * Set to true if used inside a `BentoButton` component. */ isButton?: boolean; /** * Set the rendered link to a regular external anchor link. */ isNotRouting?: boolean; /** * Sets the target of the rendered link. */ target?: string; /** * Set to true to truncate link. Doesn't work with disableTypography. */ truncate?: boolean; /** * Link variant type affecting visual style. * @values default, quiet */ variant?: BentoLinkVariant | `${BentoLinkVariant}`; } export type BentoLinkProps = RouterLinkProps & LinkProps; 

package/dist/assets/components/link/link.vue

@@ -1 +1 @@
-<template> <a v-if="external || isNotRouting" :class="conditionalClasses" v-bind="$attrs" :aria-describedby="external ? externalLinkId : null" :href="$props.to.toString()" :title="getAttributeTitle($attrs.title)" :target="computedTarget" @click="onClick" > <bento-typography v-if="!disableTypography" class="b-link__text" el="span" variant="body"> <slot /> </bento-typography> <slot v-else /> <span v-if="showExternalLinkIcon" aria-hidden="true" class="b-link__external-link-icon"> <external-link-icon /> </span> <span v-if="external" :id="externalLinkId" class="b-link--visually-hidden">{{ t('opensInNewTab') }}</span> </a> <router-link v-else v-bind="{ ...$attrs, ...$props, ...nonForwardedProps }" :class="conditionalClasses" :target="target" :to="props.to" custom @click.native="onClick" > <bento-typography v-if="!disableTypography" class="b-link__text" el="span" variant="body"> <slot /> </bento-typography> <slot v-else /> </router-link> </template> <script setup lang="ts"> import { RouterLink } from 'vue-router'; import { computed } from 'vue'; import { generateUid } from '@/core/utils/ts'; import { BentoTypography } from '@/components/typography'; import { type BentoLinkProps, BentoLinkVariant } from './link.types'; import { useI18n } from '@/utils/ts/i18n'; import type { RouterLinkSlotArgument } from 'vue-router/types/router.d.ts'; import ExternalLinkIcon from '@adyen/ui-assets-icons-16/vue/external-link'; import messages from './messages.json'; type MessageSchema = (typeof messages)['en-US']; const { t } = useI18n<{ message: MessageSchema }>({ messages }); const props = withDefaults(defineProps<BentoLinkProps>(), { target: null, variant: BentoLinkVariant.DEFAULT, }); // Props that should not be forwarded to the underlying anchor element const nonForwardedProps = { variant: undefined, isButton: undefined, truncate: undefined, disableTypography: undefined, external: undefined, isNotRouting: undefined, }; const externalLinkId = generateUid('external-link'); const getAttributeTitle = (attributesTitle: unknown) => attributesTitle as string; const conditionalClasses = computed(() => ({ 'b-link': !props.isButton, [`b-link--${BentoLinkVariant.QUIET}`]: props.variant === BentoLinkVariant.QUIET, [`b-link--truncate`]: props.truncate, })); const computedTarget = computed(() => (props.external ? (props.target ?? '_blank') : props.target)); const showExternalLinkIcon = computed(() => !(props.isButton || props.isNotRouting)); const emit = defineEmits<{ (e: 'click', clickEvent: MouseEvent): void; }>(); const onClick = (e: MouseEvent, navigateCallback?: RouterLinkSlotArgument['navigate']) => { emit('click', e); if (navigateCallback) { navigateCallback(); } }; </script> <script lang="ts"> /** * Extends the `router-link` from the `vue-router` NPM package. * * @example * import { BentoLink } from '@adyen/bento-vue2'; * * export default { * components: { BentoLink }, * template: ` * <bento-link to="/"> * link * </bento-link> * ` * } */ export default { name: 'bento-link', inheritAttrs: false, i18n: { messages }, }; </script> <style lang="scss" scoped src="@/core/components/link/link.scss" /> 
+<template> <a v-if="external || isNotRouting" :class="conditionalClasses" v-bind="$attrs" :aria-describedby="external ? externalLinkId : null" :href="$props.to.toString()" :title="getAttributeTitle($attrs.title)" :target="computedTarget" @click="onClick" > <bento-typography v-if="!disableTypography" class="b-link__text" el="span" variant="body"> <slot /> </bento-typography> <slot v-else /> <span v-if="showExternalLinkIcon" aria-hidden="true" class="b-link__external-link-icon"> <external-link-icon /> </span> <span v-if="external" :id="externalLinkId" class="b-link--visually-hidden">{{ t('opensInNewTab') }}</span> </a> <router-link v-else v-bind="{ ...$attrs, ...$props, ...nonForwardedProps }" :class="conditionalClasses" :target="target" :to="props.to" custom @click.native="onClick" > <bento-typography v-if="!disableTypography" class="b-link__text" el="span" variant="body"> <slot /> </bento-typography> <slot v-else /> </router-link> </template> <script setup lang="ts"> import { RouterLink } from 'vue-router'; import { computed } from 'vue'; import { generateUid } from '@/utils/ts/generate-uid'; import { BentoTypography } from '@/components/typography'; import { type BentoLinkProps, BentoLinkVariant } from './link.types'; import { useI18n } from '@/utils/ts/i18n'; import type { RouterLinkSlotArgument } from 'vue-router/types/router.d.ts'; import ExternalLinkIcon from '@adyen/ui-assets-icons-16/vue/external-link'; import messages from './messages.json'; type MessageSchema = (typeof messages)['en-US']; const { t } = useI18n<{ message: MessageSchema }>({ messages }); const props = withDefaults(defineProps<BentoLinkProps>(), { target: null, variant: BentoLinkVariant.DEFAULT, }); // Props that should not be forwarded to the underlying anchor element const nonForwardedProps = { variant: undefined, isButton: undefined, truncate: undefined, disableTypography: undefined, external: undefined, isNotRouting: undefined, }; const externalLinkId = generateUid('external-link'); const getAttributeTitle = (attributesTitle: unknown) => attributesTitle as string; const conditionalClasses = computed(() => ({ 'b-link': !props.isButton, [`b-link--${BentoLinkVariant.QUIET}`]: props.variant === BentoLinkVariant.QUIET, [`b-link--truncate`]: props.truncate, })); const computedTarget = computed(() => (props.external ? (props.target ?? '_blank') : props.target)); const showExternalLinkIcon = computed(() => !(props.isButton || props.isNotRouting)); const emit = defineEmits<{ (e: 'click', clickEvent: MouseEvent): void; }>(); const onClick = (e: MouseEvent, navigateCallback?: RouterLinkSlotArgument['navigate']) => { emit('click', e); if (navigateCallback) { navigateCallback(); } }; </script> <script lang="ts"> /** * Extends the `router-link` from the `vue-router` NPM package. * * @example * import { BentoLink } from '@adyen/bento-vue2'; * * export default { * components: { BentoLink }, * template: ` * <bento-link to="/"> * link * </bento-link> * ` * } */ export default { name: 'bento-link', inheritAttrs: false, i18n: { messages }, }; </script> <style lang="scss" scoped src="./link.scss" /> 

package/dist/assets/components/list/list.stories.ts

@@ -1 +1 @@
-import { ref } from 'vue'; import { action } from '@storybook/addon-actions'; import { BentoButton } from '@/components/button'; import { BentoToggle } from '@/components/toggle'; import BentoList from './list.vue'; import BentoListItem from './components/list-item/list-item.vue'; import { storybookDocsParameter } from '@/utils/ts/storybook'; import ListDefault from './__tests__/list-default.vue?raw'; import ListEverythingBagel from './__tests__/list-everything-bagel.vue?raw'; import { isVue2 } from 'vue-demi'; import type { Meta, StoryObj } from '@storybook/vue'; const meta: Meta = { title: 'List', component: BentoList, argTypes: { type: { options: ['unordered', 'ordered'], control: { type: 'select', }, }, }, }; export default meta; type Story = StoryObj<typeof BentoList>; export const Default: Story = { render: (_args, { argTypes }) => ({ components: { BentoList, BentoListItem, BentoButton, BentoToggle }, props: Object.keys(argTypes), template: ` <bento-list v-bind="args"> <bento-list-item label="Payment details" description="Updated 2 hours ago" :tag="{ label: 'Live', variant: 'green' }" show-bottom-divider > <template #start> <bento-toggle aria-label="Payment details" /> </template> <template #end> <bento-button variant="secondary">Edit</bento-button> </template> </bento-list-item> <bento-list-item label="Payout settings" description="Updated yesterday" :tag="{ label: 'Review', variant: 'orange' }" show-bottom-divider > <template #start> <bento-toggle aria-label="Payout settings" /> </template> <template #end> <bento-button variant="secondary">Edit</bento-button> </template> </bento-list-item> <bento-list-item label="Risk configuration" description="Updated 3 days ago" :tag="{ label: 'Draft', variant: 'grey' }" > <template #start> <bento-toggle aria-label="Risk configuration" /> </template> <template #end> <bento-button variant="secondary">Edit</bento-button> </template> </bento-list-item> </bento-list> `, setup(props) { return { args: isVue2 ? props : _args, }; }, }), args: { type: 'unordered', }, parameters: storybookDocsParameter(ListDefault), }; export const EverythingBagel: Story = { render: (_args, { argTypes }) => ({ components: { BentoList, BentoListItem, BentoButton, BentoToggle }, props: Object.keys(argTypes), template: ` <bento-list v-bind="args" @reorder="onReorder"> <bento-list-item v-for="item in items" :key="item.id" :label="item.label" :description="item.description" :tag="item.tag" :show-status="item.showStatus" :status-color="item.statusColor" :draggable-options="item.draggableOptions" show-bottom-divider > <template v-if="item.showToggle" #start> <bento-toggle :aria-label="item.label" /> </template> <template v-if="item.showEdit" #end> <bento-button variant="secondary">Edit</bento-button> </template> </bento-list-item> </bento-list> `, setup(props) { const items = ref([ { id: 'payment', label: 'Payment details', description: 'Updated 2 hours ago', tag: { label: 'Live', variant: 'green' }, showStatus: true, statusColor: 'green', showToggle: true, showEdit: true, }, { id: 'payout', label: 'Payout settings', description: 'Updated yesterday', tag: { label: 'Review', variant: 'orange' }, showStatus: true, statusColor: 'orange', showToggle: true, showEdit: true, }, { id: 'risk', label: 'Risk configuration', description: 'Updated 3 days ago', tag: { label: 'Draft', variant: 'grey' }, showStatus: true, }, { id: 'compliance', label: 'Compliance check', description: 'Locked by admin', draggableOptions: { disabled: true }, }, ]); const reorderAction = action('reorder'); const onReorder = ({ oldIndex, newIndex }: { oldIndex: number; newIndex: number }) => { const updated = [...items.value]; const [moved] = updated.splice(oldIndex, 1); updated.splice(newIndex, 0, moved); items.value = updated; reorderAction({ oldIndex, newIndex, order: updated.map(i => i.label) }); }; return { args: isVue2 ? props : _args, items, onReorder, }; }, }), args: { type: 'unordered', draggable: true, draggableOptions: { animation: 150 }, }, parameters: storybookDocsParameter(ListEverythingBagel), }; 
+import { ref } from 'vue'; import { action } from '@storybook/addon-actions'; import { BentoButton } from '@/components/button'; import { BentoToggle } from '@/components/toggle'; import BentoList from './list.vue'; import BentoListItem from './components/list-item/list-item.vue'; import { storybookDocsParameter } from '@/utils/ts/storybook'; const ListDefault = "<template>\n <bento-list>\n <bento-list-item\n label=\"Payment details\"\n description=\"Updated 2 hours ago\"\n :tag=\"{ label: 'Live', variant: 'green' }\"\n show-bottom-divider\n >\n <template #start>\n <bento-toggle aria-label=\"Payment details\" />\n </template>\n <template #end>\n <bento-button variant=\"secondary\">Edit</bento-button>\n </template>\n </bento-list-item>\n\n <bento-list-item\n label=\"Payout settings\"\n description=\"Updated yesterday\"\n :tag=\"{ label: 'Review', variant: 'orange' }\"\n show-bottom-divider\n >\n <template #start>\n <bento-toggle aria-label=\"Payout settings\" />\n </template>\n <template #end>\n <bento-button variant=\"secondary\">Edit</bento-button>\n </template>\n </bento-list-item>\n\n <bento-list-item\n label=\"Risk configuration\"\n description=\"Updated 3 days ago\"\n :tag=\"{ label: 'Draft', variant: 'grey' }\"\n >\n <template #start>\n <bento-toggle aria-label=\"Risk configuration\" />\n </template>\n <template #end>\n <bento-button variant=\"secondary\">Edit</bento-button>\n </template>\n </bento-list-item>\n </bento-list>\n</template>\n\n<script setup lang=\"ts\">\n import { BentoButton, BentoList, BentoListItem, BentoToggle } from '@adyen/bento-vue2';\n</script>\n"; const ListEverythingBagel = "<template>\n <bento-list draggable :draggable-options=\"{ animation: 150 }\" @reorder=\"onReorder\">\n <bento-list-item\n v-for=\"item in items\"\n :key=\"item.id\"\n :label=\"item.label\"\n :description=\"item.description\"\n :tag=\"item.tag\"\n :show-status=\"item.showStatus\"\n :status-color=\"item.statusColor\"\n :draggable-options=\"item.draggableOptions\"\n show-bottom-divider\n >\n <template v-if=\"item.showToggle\" #start>\n <bento-toggle :aria-label=\"item.label\" />\n </template>\n <template v-if=\"item.showEdit\" #end>\n <bento-button variant=\"secondary\">Edit</bento-button>\n </template>\n </bento-list-item>\n </bento-list>\n</template>\n\n<script setup lang=\"ts\">\n import { ref } from 'vue';\n import { BentoButton, BentoList, BentoListItem, type BentoListItemProps, BentoToggle } from '@adyen/bento-vue2';\n\n interface ListItem extends BentoListItemProps {\n id: string;\n showToggle?: boolean;\n showEdit?: boolean;\n }\n\n const items = ref<Array<ListItem>>([\n {\n id: 'payment',\n label: 'Payment details',\n description: 'Updated 2 hours ago',\n tag: { label: 'Live', variant: 'green' },\n showStatus: true,\n statusColor: 'green',\n showToggle: true,\n showEdit: true,\n },\n {\n id: 'payout',\n label: 'Payout settings',\n description: 'Updated yesterday',\n tag: { label: 'Review', variant: 'orange' },\n showStatus: true,\n statusColor: 'orange',\n showToggle: true,\n showEdit: true,\n },\n {\n id: 'risk',\n label: 'Risk configuration',\n description: 'Updated 3 days ago',\n tag: { label: 'Draft', variant: 'grey' },\n showStatus: true,\n },\n {\n id: 'compliance',\n label: 'Compliance check',\n description: 'Locked by admin',\n draggableOptions: { disabled: true },\n },\n ]);\n\n const onReorder = ({ oldIndex, newIndex }: { oldIndex: number; newIndex: number }) => {\n const updated = [...items.value];\n const [moved] = updated.splice(oldIndex, 1);\n updated.splice(newIndex, 0, moved);\n items.value = updated;\n };\n</script>\n"; import { isVue2 } from 'vue-demi'; import type { Meta, StoryObj } from '@storybook/vue'; const meta: Meta = { title: 'List', component: BentoList, argTypes: { type: { options: ['unordered', 'ordered'], control: { type: 'select', }, }, }, }; export default meta; type Story = StoryObj<typeof BentoList>; export const Default: Story = { render: (_args, { argTypes }) => ({ components: { BentoList, BentoListItem, BentoButton, BentoToggle }, props: Object.keys(argTypes), template: ` <bento-list v-bind="args"> <bento-list-item label="Payment details" description="Updated 2 hours ago" :tag="{ label: 'Live', variant: 'green' }" show-bottom-divider > <template #start> <bento-toggle aria-label="Payment details" /> </template> <template #end> <bento-button variant="secondary">Edit</bento-button> </template> </bento-list-item> <bento-list-item label="Payout settings" description="Updated yesterday" :tag="{ label: 'Review', variant: 'orange' }" show-bottom-divider > <template #start> <bento-toggle aria-label="Payout settings" /> </template> <template #end> <bento-button variant="secondary">Edit</bento-button> </template> </bento-list-item> <bento-list-item label="Risk configuration" description="Updated 3 days ago" :tag="{ label: 'Draft', variant: 'grey' }" > <template #start> <bento-toggle aria-label="Risk configuration" /> </template> <template #end> <bento-button variant="secondary">Edit</bento-button> </template> </bento-list-item> </bento-list> `, setup(props) { return { args: isVue2 ? props : _args, }; }, }), args: { type: 'unordered', }, parameters: storybookDocsParameter(ListDefault), }; export const EverythingBagel: Story = { render: (_args, { argTypes }) => ({ components: { BentoList, BentoListItem, BentoButton, BentoToggle }, props: Object.keys(argTypes), template: ` <bento-list v-bind="args" @reorder="onReorder"> <bento-list-item v-for="item in items" :key="item.id" :label="item.label" :description="item.description" :tag="item.tag" :show-status="item.showStatus" :status-color="item.statusColor" :draggable-options="item.draggableOptions" show-bottom-divider > <template v-if="item.showToggle" #start> <bento-toggle :aria-label="item.label" /> </template> <template v-if="item.showEdit" #end> <bento-button variant="secondary">Edit</bento-button> </template> </bento-list-item> </bento-list> `, setup(props) { const items = ref([ { id: 'payment', label: 'Payment details', description: 'Updated 2 hours ago', tag: { label: 'Live', variant: 'green' }, showStatus: true, statusColor: 'green', showToggle: true, showEdit: true, }, { id: 'payout', label: 'Payout settings', description: 'Updated yesterday', tag: { label: 'Review', variant: 'orange' }, showStatus: true, statusColor: 'orange', showToggle: true, showEdit: true, }, { id: 'risk', label: 'Risk configuration', description: 'Updated 3 days ago', tag: { label: 'Draft', variant: 'grey' }, showStatus: true, }, { id: 'compliance', label: 'Compliance check', description: 'Locked by admin', draggableOptions: { disabled: true }, }, ]); const reorderAction = action('reorder'); const onReorder = ({ oldIndex, newIndex }: { oldIndex: number; newIndex: number }) => { const updated = [...items.value]; const [moved] = updated.splice(oldIndex, 1); updated.splice(newIndex, 0, moved); items.value = updated; reorderAction({ oldIndex, newIndex, order: updated.map(i => i.label) }); }; return { args: isVue2 ? props : _args, items, onReorder, }; }, }), args: { type: 'unordered', draggable: true, draggableOptions: { animation: 150 }, }, parameters: storybookDocsParameter(ListEverythingBagel), }; 

package/dist/assets/components/loading-indicator/loading-indicator.stories.ts

@@ -1 +1 @@
-import { isVue2 } from 'vue-demi'; import BentoLoadingIndicator from './loading-indicator.vue'; import { storybookDocsParameter } from '@/utils/ts/storybook'; export default { title: 'Loading Indicator', component: BentoLoadingIndicator, parameters: { layout: 'centered', }, argTypes: { small: { if: { arg: 'large', truthy: false } }, large: { if: { arg: 'small', truthy: false } }, }, }; export const Default = (_args, { argTypes }) => ({ components: { BentoLoadingIndicator }, props: Object.keys(argTypes), setup: props => ({ args: isVue2 ? props : _args }), template: ` <bento-loading-indicator v-bind="args" /> `, }); const defaultCode = ` <loading-indicator /> `; Default.args = {}; Default.parameters = storybookDocsParameter(defaultCode); 
+import { isVue2 } from 'vue-demi'; import BentoLoadingIndicator from './loading-indicator.vue'; import { storybookDocsParameter } from '@/utils/ts/storybook'; const LoadingIndicatorDefaultExample = "<template>\n <bento-loading-indicator />\n</template>\n\n<script setup lang=\"ts\">\n import { BentoLoadingIndicator } from '@adyen/bento-vue2';\n</script>\n"; export default { title: 'Loading Indicator', component: BentoLoadingIndicator, parameters: { layout: 'centered', }, argTypes: { small: { if: { arg: 'large', truthy: false } }, large: { if: { arg: 'small', truthy: false } }, }, }; export const Default = (_args, { argTypes }) => ({ components: { BentoLoadingIndicator }, props: Object.keys(argTypes), setup: props => ({ args: isVue2 ? props : _args }), template: ` <bento-loading-indicator v-bind="args" /> `, }); Default.args = {}; Default.parameters = storybookDocsParameter(LoadingIndicatorDefaultExample); 

package/dist/assets/components/menu/components/menu-item/menu-item.types.ts

@@ -1 +1 @@
-import type { VueNodeElement } from '@/types/elements'; export interface BentoMenuItem { text: string; handler: () => void; secondaryText?: string; items?: Array<BentoMenuItem>; disabled?: boolean; chevron?: boolean; icon?: VueNodeElement; critical?: boolean; indent?: boolean; addDivider?: boolean; skipClose?: boolean; } 
+import type { VueNodeElement } from '@/types/elements'; import type { BentoLinkProps } from '@/components/link/link.types'; export interface BentoMenuItem { text: string; handler?: () => void; link?: BentoLinkProps; secondaryText?: string; items?: Array<BentoMenuItem>; disabled?: boolean; chevron?: boolean; icon?: VueNodeElement; critical?: boolean; indent?: boolean; addDivider?: boolean; skipClose?: boolean; } 

package/dist/assets/components/menu/components/menu-item/menu-item.vue

@@ -1 +1 @@
-<template> <base-button class="b-menu-item" role="menuitem" :class="conditionalClasses" :disabled="disabled" tabindex="-1" @click="onClick" > <template v-if="icon" #iconLeft> <component :is="icon" class="b-menu-item__icon-left" aria-hidden="true" /> </template> <template #default> <bento-typography el="span" variant="body" :stronger="isTitle" class="b-menu-item__primary-text"> {{ text }} </bento-typography> <bento-typography v-if="computedSecondaryText" el="span" variant="body" class="b-menu-item__secondary-text"> {{ computedSecondaryText }} </bento-typography> </template> <template v-if="chevron" #iconRight><chevron-right-icon aria-hidden="true" /></template> </base-button> </template> <script lang="ts"> import { BaseButton, BentoBaseButtonEvent } from '@/components/internal/base-button'; import { BentoTypography } from '@/components/typography'; import { truncate } from '@/utils/ts/truncate'; import ChevronRightIcon from '@adyen/ui-assets-icons-16/vue/chevron-right'; import { computed, defineComponent, type PropType } from 'vue'; import { type BentoMenuItem } from './menu-item.types'; /** * Menu item component to render items in a menu. For internal use only. */ export default defineComponent({ name: 'menu-item', components: { BaseButton, BentoTypography, ChevronRightIcon }, props: { /** * menu-item text that gets displayed as the main label */ text: { type: String, required: true, }, /** * menu-item action that gets executed when the MeniItem is clicked */ handler: { type: Function as PropType<BentoMenuItem['handler']>, required: true, }, /** * menu-item text that gets displayed as the secondary label */ secondaryText: { type: String, default: null, }, /** * Optional chevron icon displayed to the right of the menu-item */ chevron: { type: Boolean, default: false, }, /** * Optional icon displayed to the left of the menu-item */ icon: { // Types for Vue2 (Object) and Vue3 (Function) // TODO: Remove Object when fully migrated to Vue3 type: [Object, Function] as PropType<BentoMenuItem['icon']>, default: null, }, /** * Disables menu-item button functionality */ disabled: { type: Boolean, default: false, }, /** * Displays an indent variant od the menu-item */ indent: { type: Boolean, default: false, }, /** * Displays menu-item button as critical */ critical: { type: Boolean, default: false, }, /** * Renders the text in a bold variant */ isTitle: { type: Boolean, default: false, }, }, emits: [BentoBaseButtonEvent.CLICK], setup(props, { emit }) { const MAX_SECONDARY_TEXT_LENGTH = 10; const conditionalClasses = computed(() => ({ 'b-menu-item--critical': props.critical, 'b-menu-item--indent': props.indent, })); const computedSecondaryText = computed(() => truncate(props.secondaryText, MAX_SECONDARY_TEXT_LENGTH)); const onClick = (e: MouseEvent) => { e.stopPropagation(); props.handler(); emit(BentoBaseButtonEvent.CLICK); }; return { // Values conditionalClasses, computedSecondaryText, // Methods onClick, }; }, }); </script> <style lang="scss" scoped src="./menu-item.scss" /> 
+<template> <base-button class="b-menu-item" role="menuitem" :class="conditionalClasses" :disabled="disabled" :link="link" tabindex="-1" @click="onClick" > <template v-if="icon" #iconLeft> <component :is="icon" class="b-menu-item__icon-left" aria-hidden="true" /> </template> <template #default> <bento-typography el="span" variant="body" :stronger="isTitle" class="b-menu-item__primary-text"> {{ text }} </bento-typography> <span v-if="isExternalLink" class="b-menu-item__external-link-icon"> <external-link-icon aria-hidden="true" /> </span> <bento-typography v-else-if="computedSecondaryText" el="span" variant="body" class="b-menu-item__secondary-text" > {{ computedSecondaryText }} </bento-typography> </template> <template v-if="chevron" #iconRight><chevron-right-icon aria-hidden="true" /></template> </base-button> </template> <script lang="ts"> import { BaseButton, BentoBaseButtonEvent } from '@/components/internal/base-button'; import { BentoTypography } from '@/components/typography'; import { truncate } from '@/utils/ts/truncate'; import ChevronRightIcon from '@adyen/ui-assets-icons-16/vue/chevron-right'; import ExternalLinkIcon from '@adyen/ui-assets-icons-16/vue/external-link'; import { computed, defineComponent, type PropType } from 'vue'; import { type BentoMenuItem } from './menu-item.types'; /** * Menu item component to render items in a menu. For internal use only. */ export default defineComponent({ name: 'menu-item', components: { BaseButton, BentoTypography, ChevronRightIcon, ExternalLinkIcon }, props: { /** * menu-item text that gets displayed as the main label */ text: { type: String, required: true, }, /** * Optional click event handler. */ handler: { type: Function as PropType<BentoMenuItem['handler']>, default: undefined, }, /** * Renders the menu-item as a link. Accepts the same props as `BentoLink`. */ link: { type: Object as PropType<BentoMenuItem['link']>, default: undefined, }, /** * menu-item text that gets displayed as the secondary label */ secondaryText: { type: String, default: null, }, /** * Optional chevron icon displayed to the right of the menu-item */ chevron: { type: Boolean, default: false, }, /** * Optional icon displayed to the left of the menu-item */ icon: { // Types for Vue2 (Object) and Vue3 (Function) // TODO: Remove Object when fully migrated to Vue3 type: [Object, Function] as PropType<BentoMenuItem['icon']>, default: null, }, /** * Disables menu-item button functionality */ disabled: { type: Boolean, default: false, }, /** * Displays an indent variant od the menu-item */ indent: { type: Boolean, default: false, }, /** * Displays menu-item button as critical */ critical: { type: Boolean, default: false, }, /** * Renders the text in a bold variant */ isTitle: { type: Boolean, default: false, }, }, emits: [BentoBaseButtonEvent.CLICK], setup(props, { emit }) { const MAX_SECONDARY_TEXT_LENGTH = 10; const conditionalClasses = computed(() => ({ 'b-menu-item--critical': props.critical, 'b-menu-item--disabled': props.disabled, 'b-menu-item--indent': props.indent, })); const computedSecondaryText = computed(() => truncate(props.secondaryText, MAX_SECONDARY_TEXT_LENGTH)); const isExternalLink = computed(() => !!props.link?.external); const onClick = (e: MouseEvent) => { e.stopPropagation(); props.handler?.(); emit(BentoBaseButtonEvent.CLICK); }; return { // Values conditionalClasses, computedSecondaryText, isExternalLink, // Methods onClick, }; }, }); </script> <style lang="scss" scoped src="./menu-item.scss" /> 

package/dist/assets/components/menu/components/menu-item-list/menu-item-list.vue

@@ -1 +1 @@
-<template> <menu-list-container ref="menuItemListWrapperRef" :style="computedStyle"> <ul ref="menuItemListRef" class="b-menu-item-list" role="menu" @keydown.down="focusNext" @keydown.up="focusPrevious" @keydown.esc="closeMenu" @keydown.tab="closeMenu" > <li v-for="(item, index) in computedData" :key="`menu-item-${index}`" ref="menuItemRef" class="b-menu-item-list__item" role="none" @keydown.right="focusRight(item, index)" @keydown.left="focusLeft()" > <menu-item :text="item.text" :handler="!item.items?.length ? item.handler : () => null" :secondary-text="item.secondaryText" :icon="item.icon" :chevron="!!item.items?.length" :disabled="item.disabled" :critical="item.critical" :indent="item.indent" :tabindex="index === subMenuFocusedIndex ? '0' : '-1'" :aria-haspopup="!!item.items?.length" :aria-expanded="showSubMenu && visibleSubMenuIndex === index" @click="menuItemClick(item, index)" /> <bento-divider v-if="item.addDivider" class="b-menu-item-list__divider" /> <sub-menu-item-list v-if="item.items?.length && showSubMenu && visibleSubMenuIndex === index" ref="subMenuItemListRef" :items="item.items" :title="item.text" @back="onBackButton" @close="closeMenu" /> </li> </ul> </menu-list-container> </template> <script lang="ts"> import { computed, defineComponent, nextTick, type PropType, ref, toRef } from 'vue'; import { isVue3 } from 'vue-demi'; import { BentoDivider } from '@/components/divider'; import { type BentoMenuItem, MenuItem } from '../menu-item'; import { BentoMenuEvent } from '../../menu.types'; import MenuListContainer from '../menu-list-container/menu-list-container.vue'; import SubMenuItemList from '../sub-menu-item-list/sub-menu-item-list.vue'; import { useDynamicMenuSize } from '../../composables'; /** * MenuItem list to be used in the Menu component. For internal use only. */ export default defineComponent({ name: 'menu-item-list', components: { BentoDivider, MenuItem, MenuListContainer, SubMenuItemList }, props: { /** * The data to be displayed in the list */ data: { type: Array as PropType<Array<BentoMenuItem>>, required: true, }, /** * Displays the menu-items of the list in the indent variant. Only applies to elements that don't have an icon to their left. */ indentItems: { type: Boolean, default: false, }, /** * If set to true, focuses the last item on the list instead of the first. Used for accessibility purposes when the menu is opened with the 'up' arrow key. */ focusLastElement: { type: Boolean, default: false, }, /** * If set to true, closes the menu when an item is clicked. */ closeMenuOnItemSelect: { type: Boolean, default: true, }, /** * The custom popover width if one has been set */ popoverWidth: { type: Number, default: null, }, }, emits: [BentoMenuEvent.CLOSE, 'menu-item-click'], setup(props, { emit, expose }) { const menuItemRef = ref(null); const menuItemListRef = ref(null); const menuItemListWrapperRef = ref(null); const subMenuItemListRef = ref(null); const showSubMenu = ref(false); const visibleSubMenuIndex = ref(null); const focusedIndex = ref(props.focusLastElement ? props.data.length - 1 : 0); const subMenuFocusedIndex = ref(0); const numberOfItems = ref(props.data.length - 1); const hasMenuItemsWithIcon = computed(() => props.data.some(el => el.icon)); const computedData = computed(() => { if (props.indentItems || hasMenuItemsWithIcon.value) { return props.data.map(el => { let indent = false; if (!el.icon) { indent = true; } return { ...el, indent, }; }); } return props.data; }); const focusItem = async () => { // vue 3 requires nextTick to be called before an item can be focused // this function does not need to be awaited itself if (isVue3) { await nextTick(); } menuItemListRef.value?.children[focusedIndex.value]?.children[0]?.focus(); }; const closeMenu = () => emit(BentoMenuEvent.CLOSE); const menuItemClick = (item: BentoMenuItem, index: number) => { if (item.items) { visibleSubMenuIndex.value = index; showSubMenu.value = true; return; } visibleSubMenuIndex.value = index; showSubMenu.value = false; if (!item.skipClose && props.closeMenuOnItemSelect !== false) { closeMenu(); } emit('menu-item-click'); }; const focusPrevious = () => { if (focusedIndex.value > 0) { focusedIndex.value -= 1; if (computedData.value[focusedIndex.value].disabled) { focusPrevious(); } } else { focusedIndex.value = numberOfItems.value; } focusItem(); }; const focusNext = () => { if (focusedIndex.value < numberOfItems.value) { focusedIndex.value += 1; if (computedData.value[focusedIndex.value].disabled) { focusNext(); } } else { focusedIndex.value = 0; } focusItem(); }; const focusRight = (item, index) => { if (item?.items?.length) { visibleSubMenuIndex.value = index; showSubMenu.value = true; } }; const focusLeft = () => { if (visibleSubMenuIndex.value && showSubMenu.value) { visibleSubMenuIndex.value = null; showSubMenu.value = false; } }; const onBackButton = () => { showSubMenu.value = false; visibleSubMenuIndex.value = null; // Focus the right element focusItem(); }; expose({ focusItem, }); const { computedStyle } = useDynamicMenuSize( subMenuItemListRef, visibleSubMenuIndex, showSubMenu, toRef(props, 'popoverWidth') ); return { // Values menuItemListRef, menuItemListWrapperRef, subMenuItemListRef, menuItemRef, computedData, computedStyle, focusedIndex, subMenuFocusedIndex, showSubMenu, visibleSubMenuIndex, // Methods menuItemClick, closeMenu, focusPrevious, focusNext, focusRight, focusLeft, onBackButton, }; }, }); </script> <style lang="scss" scoped src="./menu-item-list.scss" /> 
+<template> <menu-list-container ref="menuItemListWrapperRef" :style="computedStyle"> <ul ref="menuItemListRef" class="b-menu-item-list" role="menu" @keydown.down="focusNext" @keydown.up="focusPrevious" @keydown.esc="closeMenu" @keydown.tab="closeMenu" > <li v-for="(item, index) in computedData" :key="`menu-item-${index}`" ref="menuItemRef" class="b-menu-item-list__item" role="none" @keydown.right="focusRight(item, index)" @keydown.left="focusLeft()" > <menu-item :text="item.text" :handler="!item.items?.length ? item.handler : () => null" :link="!item.items?.length ? item.link : undefined" :secondary-text="item.secondaryText" :icon="item.icon" :chevron="!!item.items?.length" :disabled="item.disabled" :critical="item.critical" :indent="item.indent" :tabindex="index === subMenuFocusedIndex ? '0' : '-1'" :aria-haspopup="!!item.items?.length" :aria-expanded="showSubMenu && visibleSubMenuIndex === index" @click="menuItemClick(item, index)" /> <bento-divider v-if="item.addDivider" class="b-menu-item-list__divider" /> <sub-menu-item-list v-if="item.items?.length && showSubMenu && visibleSubMenuIndex === index" ref="subMenuItemListRef" :items="item.items" :title="item.text" @back="onBackButton" @close="closeMenu" /> </li> </ul> </menu-list-container> </template> <script lang="ts"> import { computed, defineComponent, nextTick, type PropType, ref, toRef } from 'vue'; import { isVue3 } from 'vue-demi'; import { BentoDivider } from '@/components/divider'; import { type BentoMenuItem, MenuItem } from '../menu-item'; import { BentoMenuEvent } from '../../menu.types'; import MenuListContainer from '../menu-list-container/menu-list-container.vue'; import SubMenuItemList from '../sub-menu-item-list/sub-menu-item-list.vue'; import { useDynamicMenuSize } from '../../composables'; /** * MenuItem list to be used in the Menu component. For internal use only. */ export default defineComponent({ name: 'menu-item-list', components: { BentoDivider, MenuItem, MenuListContainer, SubMenuItemList }, props: { /** * The data to be displayed in the list */ data: { type: Array as PropType<Array<BentoMenuItem>>, required: true, }, /** * Displays the menu-items of the list in the indent variant. Only applies to elements that don't have an icon to their left. */ indentItems: { type: Boolean, default: false, }, /** * If set to true, focuses the last item on the list instead of the first. Used for accessibility purposes when the menu is opened with the 'up' arrow key. */ focusLastElement: { type: Boolean, default: false, }, /** * If set to true, closes the menu when an item is clicked. */ closeMenuOnItemSelect: { type: Boolean, default: true, }, /** * The custom popover width if one has been set */ popoverWidth: { type: Number, default: null, }, }, emits: [BentoMenuEvent.CLOSE, 'menu-item-click'], setup(props, { emit, expose }) { const menuItemRef = ref(null); const menuItemListRef = ref(null); const menuItemListWrapperRef = ref(null); const subMenuItemListRef = ref(null); const showSubMenu = ref(false); const visibleSubMenuIndex = ref(null); const focusedIndex = ref(props.focusLastElement ? props.data.length - 1 : 0); const subMenuFocusedIndex = ref(0); const numberOfItems = ref(props.data.length - 1); const hasMenuItemsWithIcon = computed(() => props.data.some(el => el.icon)); const computedData = computed(() => { if (props.indentItems || hasMenuItemsWithIcon.value) { return props.data.map(el => { let indent = false; if (!el.icon) { indent = true; } return { ...el, indent, }; }); } return props.data; }); const focusItem = async () => { // vue 3 requires nextTick to be called before an item can be focused // this function does not need to be awaited itself if (isVue3) { await nextTick(); } menuItemListRef.value?.children[focusedIndex.value]?.children[0]?.focus(); }; const closeMenu = () => emit(BentoMenuEvent.CLOSE); const menuItemClick = (item: BentoMenuItem, index: number) => { if (item.items) { visibleSubMenuIndex.value = index; showSubMenu.value = true; return; } visibleSubMenuIndex.value = index; showSubMenu.value = false; if (!item.skipClose && props.closeMenuOnItemSelect !== false) { closeMenu(); } emit('menu-item-click'); }; const focusPrevious = () => { if (focusedIndex.value > 0) { focusedIndex.value -= 1; if (computedData.value[focusedIndex.value].disabled) { focusPrevious(); } } else { focusedIndex.value = numberOfItems.value; } focusItem(); }; const focusNext = () => { if (focusedIndex.value < numberOfItems.value) { focusedIndex.value += 1; if (computedData.value[focusedIndex.value].disabled) { focusNext(); } } else { focusedIndex.value = 0; } focusItem(); }; const focusRight = (item, index) => { if (item?.items?.length) { visibleSubMenuIndex.value = index; showSubMenu.value = true; } }; const focusLeft = () => { if (visibleSubMenuIndex.value && showSubMenu.value) { visibleSubMenuIndex.value = null; showSubMenu.value = false; } }; const onBackButton = () => { showSubMenu.value = false; visibleSubMenuIndex.value = null; // Focus the right element focusItem(); }; expose({ focusItem, }); const { computedStyle } = useDynamicMenuSize( subMenuItemListRef, visibleSubMenuIndex, showSubMenu, toRef(props, 'popoverWidth') ); return { // Values menuItemListRef, menuItemListWrapperRef, subMenuItemListRef, menuItemRef, computedData, computedStyle, focusedIndex, subMenuFocusedIndex, showSubMenu, visibleSubMenuIndex, // Methods menuItemClick, closeMenu, focusPrevious, focusNext, focusRight, focusLeft, onBackButton, }; }, }); </script> <style lang="scss" scoped src="./menu-item-list.scss" /> 

package/dist/assets/components/menu/components/sub-menu-item-list/sub-menu-item-list.vue

@@ -1 +1 @@
-<template> <transition name="b-sub-menu-item-list__transition" appear> <menu-list-container class="b-sub-menu-item-list"> <ul ref="subMenuItemListRefLocal" role="menu" class="b-sub-menu-item-list__list" @keydown.down.stop="focusNext" @keydown.up.stop="focusPrevious" @keydown.esc.stop="onBackButton" > <li v-for="(item, index) in computedItems" :key="`sub-menu-item-list-item-${index}`" role="none"> <menu-item :text="item.text" :handler="item.handler" :secondary-text="item.secondaryText" :icon="item.icon" :is-title="item.isTitle" :disabled="item.disabled" :critical="item.critical" :indent="item.indent" :tabindex="index === subMenuFocusedIndex ? '0' : '-1'" @click="item.clickHandler" /> <bento-divider v-if="item.addDivider" class="b-sub-menu-item-list__divider" /> </li> </ul> </menu-list-container> </transition> </template> <script lang="ts"> import { computed, defineComponent, onMounted, type PropType, ref } from 'vue'; import { BentoDivider } from '@/components/divider'; import { type BentoMenuItem, MenuItem } from '../menu-item'; import MenuListContainer from '../menu-list-container/menu-list-container.vue'; import ChevronLeftIcon from '@adyen/ui-assets-icons-16/vue/chevron-left'; import { BentoMenuEvent } from '../../menu.types'; import messages from '../../messages.json'; /** * SubMenuItemList component to render a submenu with the sliding transition. For internal use only. */ export default defineComponent({ i18n: { messages }, name: 'sub-menu-item-list', components: { BentoDivider, MenuItem, MenuListContainer }, props: { items: { type: Array as PropType<Array<BentoMenuItem>>, required: true, }, title: { type: String, required: true, }, }, emits: [BentoMenuEvent.CLOSE, BentoMenuEvent.BACK], setup(props, { emit }) { const subMenuItemListRefLocal = ref(null); const subMenuFocusedIndex = ref(0); const numberOfItems = ref(props.items.length); const closeMenu = () => emit(BentoMenuEvent.CLOSE); const onBackButton = () => emit(BentoMenuEvent.BACK); const computedItems = computed(() => { const items = props.items?.map(el => ({ ...el, indent: !el.icon, isTitle: false, clickHandler: closeMenu, })); return [ { text: props.title, secondaryText: null, critical: false, icon: ChevronLeftIcon, isTitle: true, disabled: false, indent: false, handler: onBackButton, clickHandler: onBackButton, addDivider: true, }, ...items, ]; }); const focusItem = async () => { subMenuItemListRefLocal.value?.children?.[subMenuFocusedIndex.value]?.children?.[0]?.focus(); }; onMounted(async () => { // Using setTimeout otherwise the sliding animation doesn't work anymore. The timeout imer is the same as the transition time (0.15s) setTimeout(() => focusItem(), 150); }); const focusPrevious = () => { if (subMenuFocusedIndex.value > 0) { subMenuFocusedIndex.value -= 1; if (computedItems.value[subMenuFocusedIndex.value].disabled) { focusPrevious(); } } else { subMenuFocusedIndex.value = numberOfItems.value; } focusItem(); }; const focusNext = () => { if (subMenuFocusedIndex.value < numberOfItems.value) { subMenuFocusedIndex.value += 1; if (computedItems.value[subMenuFocusedIndex.value].disabled) { focusNext(); } } else { subMenuFocusedIndex.value = 0; } focusItem(); }; return { // Enums BentoMenuEvent, // Values subMenuItemListRefLocal, subMenuFocusedIndex, ChevronLeftIcon, computedItems, // Methods closeMenu, onBackButton, focusPrevious, focusNext, }; }, }); </script> <style lang="scss" scoped src="./sub-menu-item-list.scss" /> 
+<template> <transition name="b-sub-menu-item-list__transition" appear> <menu-list-container class="b-sub-menu-item-list"> <ul ref="subMenuItemListRefLocal" role="menu" class="b-sub-menu-item-list__list" @keydown.down.stop="focusNext" @keydown.up.stop="focusPrevious" @keydown.esc.stop="onBackButton" > <li v-for="(item, index) in computedItems" :key="`sub-menu-item-list-item-${index}`" role="none"> <menu-item :text="item.text" :handler="item.handler" :link="item.link" :secondary-text="item.secondaryText" :icon="item.icon" :is-title="item.isTitle" :disabled="item.disabled" :critical="item.critical" :indent="item.indent" :tabindex="index === subMenuFocusedIndex ? '0' : '-1'" @click="item.clickHandler" /> <bento-divider v-if="item.addDivider" class="b-sub-menu-item-list__divider" /> </li> </ul> </menu-list-container> </transition> </template> <script lang="ts"> import { computed, defineComponent, onMounted, type PropType, ref } from 'vue'; import { BentoDivider } from '@/components/divider'; import { type BentoMenuItem, MenuItem } from '../menu-item'; import MenuListContainer from '../menu-list-container/menu-list-container.vue'; import ChevronLeftIcon from '@adyen/ui-assets-icons-16/vue/chevron-left'; import { BentoMenuEvent } from '../../menu.types'; import messages from '../../messages.json'; /** * SubMenuItemList component to render a submenu with the sliding transition. For internal use only. */ export default defineComponent({ i18n: { messages }, name: 'sub-menu-item-list', components: { BentoDivider, MenuItem, MenuListContainer }, props: { items: { type: Array as PropType<Array<BentoMenuItem>>, required: true, }, title: { type: String, required: true, }, }, emits: [BentoMenuEvent.CLOSE, BentoMenuEvent.BACK], setup(props, { emit }) { const subMenuItemListRefLocal = ref(null); const subMenuFocusedIndex = ref(0); const numberOfItems = ref(props.items.length); const closeMenu = () => emit(BentoMenuEvent.CLOSE); const onBackButton = () => emit(BentoMenuEvent.BACK); const computedItems = computed(() => { const items = props.items?.map(el => ({ ...el, indent: !el.icon, isTitle: false, clickHandler: closeMenu, })); return [ { text: props.title, secondaryText: null, critical: false, icon: ChevronLeftIcon, isTitle: true, disabled: false, indent: false, link: undefined, handler: onBackButton, clickHandler: onBackButton, addDivider: true, }, ...items, ]; }); const focusItem = async () => { subMenuItemListRefLocal.value?.children?.[subMenuFocusedIndex.value]?.children?.[0]?.focus(); }; onMounted(async () => { // Using setTimeout otherwise the sliding animation doesn't work anymore. The timeout imer is the same as the transition time (0.15s) setTimeout(() => focusItem(), 150); }); const focusPrevious = () => { if (subMenuFocusedIndex.value > 0) { subMenuFocusedIndex.value -= 1; if (computedItems.value[subMenuFocusedIndex.value].disabled) { focusPrevious(); } } else { subMenuFocusedIndex.value = numberOfItems.value; } focusItem(); }; const focusNext = () => { if (subMenuFocusedIndex.value < numberOfItems.value) { subMenuFocusedIndex.value += 1; if (computedItems.value[subMenuFocusedIndex.value].disabled) { focusNext(); } } else { subMenuFocusedIndex.value = 0; } focusItem(); }; return { // Enums BentoMenuEvent, // Values subMenuItemListRefLocal, subMenuFocusedIndex, ChevronLeftIcon, computedItems, // Methods closeMenu, onBackButton, focusPrevious, focusNext, }; }, }); </script> <style lang="scss" scoped src="./sub-menu-item-list.scss" /> 

package/dist/assets/components/menu/menu.docs.mdx

@@ -24,6 +24,9 @@ styling of the menu button trigger.
 
 The `bento-menu` component offers two distinct icon configurations.
 
+> **Icon Requirement:** All icon properties (`icon`, `iconLeft`, `iconRight`) strictly accept components from
+> `@adyen/ui-assets-icons-16` only. Font icons, custom SVGs, and external libraries are prohibited.
+
 - **Icon-Only:** To use this variant, provide an icon directly to the `iconLeft` slot and **omit the default slot**.
 
 - **Menu with Text:** This variant is automatically activated when you provide content to the **default slot**. For this
@@ -62,6 +65,12 @@ field to `true` in the corresponding `menu-item` object in the data array.
 Renders a divider after the `menu-item` to separate it from other content. To enable this, set `addDivider` to `true` in
 the corresponding `menu-item` object in the data array.
 
+#### Link
+
+A menu item can be rendered as a link instead of a button. To do this, set the `link` field on the item, which is
+forwarded to the internal `BentoLink` component. If `handler` is additionally provided, it will still be called
+alongside link navigation. See [BentoLink](../?path=/docs/components-link--docs) for the properties it accepts.
+
 ## Modifiers
 
 ### Menu Item

package/dist/assets/components/menu/menu.stories.ts

@@ -1 +1 @@
-import { storybookDocsParameter } from '@/utils/ts/storybook'; import { action } from '@storybook/addon-actions'; import { isVue2, ref } from 'vue-demi'; import BentoMenu from './menu.vue'; import CodeIcon from '@adyen/ui-assets-icons-16/vue/code-2'; import PeopleIcon from '@adyen/ui-assets-icons-16/vue/4-people'; import ChevronDownIcon from '@adyen/ui-assets-icons-16/vue/chevron-down'; import PlusIcon from '@adyen/ui-assets-icons-16/vue/plus'; import { BentoMenuEvent } from './menu.types'; import { type Meta, type StoryObj } from '@storybook/vue'; const MENU_DATA = [ { text: 'Menu entry', secondaryText: 'Text', handler: () => { // Your code here action('click')('Menu 1'); }, critical: true, icon: CodeIcon, }, { text: 'Menu entry 2 extra long text', secondaryText: 'Disabled', handler: () => { // Your code here action('click')('Menu 2'); }, disabled: true, addDivider: true, }, { text: 'Menu entry 3', handler: () => { // Your code here action('click')('Menu 3'); }, icon: PeopleIcon, items: [ { text: 'Submenu entry', secondaryText: 'Subtext', handler: () => { // Your code here action('click')('Submenu 1'); }, }, { text: 'Submenu entry 2', handler: () => { // Your code here action('click')('Submenu 2'); }, }, ], }, { text: 'Menu entry 4', secondaryText: 'Text', handler: () => { // Your code here action('click')('Menu 4'); }, }, ]; const meta: Meta = { title: 'Menu', component: BentoMenu, argTypes: { 'menu-item-click': { name: 'menu-item-click', defaultValue: '', description: 'When a menu item that has no submenu is clicked', table: { type: { summary: '($event) => void' }, }, control: { disable: true }, }, }, }; export default meta; const defaultCode = ` <template> <bento-menu :data="menuData" /> </template> <script setup lang="ts"> import CodeIcon from '@adyen/ui-assets-icons-16/vue/code-2'; import PeopleIcon from '@adyen/ui-assets-icons-16/vue/4-people'; const menuData = [ { text: 'Menu entry', secondaryText: 'Text', handler: () => { // Your code here }, critical: true, icon: CodeIcon, }, { text: 'Menu entry 2 extra long text', secondaryText: 'Disabled entry', handler: () => { // Your code here }, disabled: true, }, { text: 'Menu entry 3', handler: () => { // Your code here }, icon: PeopleIcon, }, ]; </script> `; export const Default = { render: (_args, { argTypes }) => ({ components: { BentoMenu }, props: Object.keys(argTypes), template: ` <bento-menu v-bind="args" @open="open" @close="close" /> `, setup(props) { return { args: isVue2 ? props : _args, [BentoMenuEvent.OPEN]: action(BentoMenuEvent.OPEN), [BentoMenuEvent.CLOSE]: action(BentoMenuEvent.CLOSE), }; }, }), args: { data: MENU_DATA, button: { variant: 'secondary', }, }, parameters: storybookDocsParameter(defaultCode), }; const withIconAndTextCode = ` <template> <bento-menu :data="menuData"> <template #iconLeft> <plus-icon /> </template> Open menu </bento-menu> </template> <script setup lang="ts"> import CodeIcon from '@adyen/ui-assets-icons-16/vue/code-2'; import PeopleIcon from '@adyen/ui-assets-icons-16/vue/4-people'; import PlusIcon from '@adyen/ui-assets-icons-16/vue/plus'; const menuData = [ { text: 'Menu entry', secondaryText: 'Text', handler: () => { // Your code here console.log('Menu entry 1 clicked'); }, critical: true, icon: CodeIcon, }, { text: 'Menu entry 2 extra long text', secondaryText: 'Disabled entry', handler: () => { // Your code here }, disabled: true, }, { text: 'Menu entry 3', handler: () => { // Your code here console.log('Menu entry 3 clicked'); }, icon: PeopleIcon, }, ]; </script> `; export const WithIconAndText: StoryObj = { ...Default, render: (_args, { argTypes }) => ({ components: { BentoMenu, CodeIcon, PlusIcon, ChevronDownIcon }, props: Object.keys(argTypes), template: ` <bento-menu v-bind="args" @open="open" @close="close"> <template #iconLeft> <plus-icon /> </template> Open menu </bento-menu> `, setup(props) { const isOpen = ref(false); const toggleMenuOpenText = () => { isOpen.value = !isOpen.value; }; return { // Values args: isVue2 ? props : _args, isOpen, // Methods [BentoMenuEvent.OPEN]: () => { toggleMenuOpenText(); action(BentoMenuEvent.OPEN)(); }, [BentoMenuEvent.CLOSE]: () => { toggleMenuOpenText(); action(BentoMenuEvent.CLOSE)(); }, }; }, }), parameters: storybookDocsParameter(withIconAndTextCode), }; 
+import { storybookDocsParameter } from '@/utils/ts/storybook'; import { action } from '@storybook/addon-actions'; import { isVue2, ref } from 'vue-demi'; import BentoMenu from './menu.vue'; import CodeIcon from '@adyen/ui-assets-icons-16/vue/code-2'; import PeopleIcon from '@adyen/ui-assets-icons-16/vue/4-people'; import ChevronDownIcon from '@adyen/ui-assets-icons-16/vue/chevron-down'; import PlusIcon from '@adyen/ui-assets-icons-16/vue/plus'; import PlusMultipleIcon from '@adyen/ui-assets-icons-16/vue/plus-multiple'; import HandRockIcon from '@adyen/ui-assets-icons-16/vue/hand-rock'; import { BentoMenuEvent } from './menu.types'; import { type Meta, type StoryObj } from '@storybook/vue'; const MenuDefaultExample = "<template>\n <bento-menu :data=\"menuData\" teleport />\n</template>\n<script setup lang=\"ts\">\n import { BentoMenu, type BentoMenuItem } from '@adyen/bento-vue2';\n import CodeIcon from '@adyen/ui-assets-icons-16/vue/code-2';\n import PlusMultipleIcon from '@adyen/ui-assets-icons-16/vue/plus-multiple';\n import PeopleIcon from '@adyen/ui-assets-icons-16/vue/4-people';\n import HandRockIcon from '@adyen/ui-assets-icons-16/vue/hand-rock';\n\n const menuData: Array<BentoMenuItem> = [\n {\n text: 'Menu entry',\n secondaryText: 'Text',\n handler: () => {\n // Your code here\n },\n critical: true,\n icon: CodeIcon,\n },\n {\n text: 'Menu entry 2 disabled extra long text',\n secondaryText: 'Secondary text',\n handler: () => {\n // Your code here\n },\n icon: CodeIcon,\n disabled: true,\n },\n {\n text: 'Open in a new tab',\n link: { to: 'https://www.adyen.com/', external: true },\n icon: PlusMultipleIcon,\n },\n {\n text: 'Disabled external link',\n link: { to: 'https://www.adyen.com/', external: true },\n disabled: true,\n icon: PlusMultipleIcon,\n addDivider: true,\n },\n {\n text: 'Menu entry 3',\n handler: () => {\n // Your code here\n },\n icon: PeopleIcon,\n items: [\n {\n text: 'Open in a new tab',\n link: { to: 'https://www.adyen.com/', external: true },\n },\n {\n text: 'Regular action',\n secondaryText: 'Text',\n handler: () => {\n // Your code here\n },\n icon: HandRockIcon,\n },\n ],\n },\n {\n text: 'Regular action',\n handler: () => {\n // Your code here\n },\n secondaryText: 'Text',\n icon: HandRockIcon,\n },\n ];\n</script>\n"; const MenuWithIconAndTextExample = "<template>\n <bento-menu :button=\"{ variant: 'secondary' }\" :data=\"menuData\" teleport>\n <template #iconLeft>\n <plus-icon />\n </template>\n Open menu\n </bento-menu>\n</template>\n\n<script setup lang=\"ts\">\n import { BentoMenu, type BentoMenuItem } from '@adyen/bento-vue2';\n import CodeIcon from '@adyen/ui-assets-icons-16/vue/code-2';\n import PeopleIcon from '@adyen/ui-assets-icons-16/vue/4-people';\n import HandRockIcon from '@adyen/ui-assets-icons-16/vue/hand-rock';\n import PlusIcon from '@adyen/ui-assets-icons-16/vue/plus';\n import PlusMultipleIcon from '@adyen/ui-assets-icons-16/vue/plus-multiple';\n\n const menuData: Array<BentoMenuItem> = [\n {\n text: 'Menu entry',\n secondaryText: 'Text',\n handler: () => undefined,\n critical: true,\n icon: CodeIcon,\n },\n {\n text: 'Menu entry disabled extra long text',\n secondaryText: 'Secondary text',\n icon: CodeIcon,\n disabled: true,\n },\n {\n text: 'Open in a new tab',\n link: { to: 'https://www.adyen.com/', external: true },\n icon: PlusMultipleIcon,\n },\n {\n text: 'Disabled external link',\n link: { to: 'https://www.adyen.com/', external: true },\n disabled: true,\n icon: PlusMultipleIcon,\n addDivider: true,\n },\n {\n text: 'Menu entry 3',\n icon: PeopleIcon,\n items: [\n {\n text: 'Open in a new tab',\n link: { to: 'https://www.adyen.com/', external: true },\n },\n {\n text: 'Regular action',\n secondaryText: 'Text',\n handler: () => undefined,\n icon: HandRockIcon,\n },\n ],\n },\n {\n text: 'Regular action',\n secondaryText: 'Text',\n handler: () => undefined,\n icon: HandRockIcon,\n },\n ];\n</script>\n"; const MENU_DATA = [ { text: 'Menu entry', secondaryText: 'Text', handler: () => { // Your code here action('click')('Menu entry action'); }, critical: true, icon: CodeIcon, }, { text: 'Menu entry disabled extra long text', secondaryText: 'Secondary text', handler: () => { // Your code here action('click')('Menu entry disabled extra long text action'); }, icon: CodeIcon, disabled: true, }, { text: 'Open in a new tab', link: { to: 'https://www.adyen.com/', external: true }, icon: PlusMultipleIcon, }, { text: 'Disabled external link', link: { to: 'https://www.adyen.com/', external: true }, disabled: true, icon: PlusMultipleIcon, addDivider: true, }, { text: 'Menu entry 3', handler: () => { // Your code here action('click')('Menu entry 3 action'); }, icon: PeopleIcon, items: [ { text: 'Open in a new tab', link: { to: 'https://www.adyen.com/', external: true }, }, { text: 'Regular action', secondaryText: 'Text', handler: () => { // Your code here action('click')('Submenu regular action'); }, icon: HandRockIcon, }, ], }, { text: 'Regular action', secondaryText: 'Text', handler: () => { // Your code here action('click')('Regular action'); }, icon: HandRockIcon, }, ]; const meta: Meta = { title: 'Menu', component: BentoMenu, argTypes: { 'menu-item-click': { name: 'menu-item-click', defaultValue: '', description: 'When a menu item that has no submenu is clicked', table: { type: { summary: '($event) => void' }, }, control: { disable: true }, }, }, }; export default meta; export const Default = { render: (_args, { argTypes }) => ({ components: { BentoMenu }, props: Object.keys(argTypes), template: ` <bento-menu v-bind="args" @open="open" @close="close" /> `, setup(props) { return { args: isVue2 ? props : _args, [BentoMenuEvent.OPEN]: action(BentoMenuEvent.OPEN), [BentoMenuEvent.CLOSE]: action(BentoMenuEvent.CLOSE), }; }, }), args: { data: MENU_DATA, button: { variant: 'secondary', }, teleport: true, }, parameters: storybookDocsParameter(MenuDefaultExample), }; export const WithIconAndText: StoryObj = { ...Default, render: (_args, { argTypes }) => ({ components: { BentoMenu, CodeIcon, PlusIcon, ChevronDownIcon }, props: Object.keys(argTypes), template: ` <bento-menu v-bind="args" @open="open" @close="close"> <template #iconLeft> <plus-icon /> </template> Open menu </bento-menu> `, setup(props) { const isOpen = ref(false); const toggleMenuOpenText = () => { isOpen.value = !isOpen.value; }; return { // Values args: isVue2 ? props : _args, isOpen, // Methods [BentoMenuEvent.OPEN]: () => { toggleMenuOpenText(); action(BentoMenuEvent.OPEN)(); }, [BentoMenuEvent.CLOSE]: () => { toggleMenuOpenText(); action(BentoMenuEvent.CLOSE)(); }, }; }, }), parameters: storybookDocsParameter(MenuWithIconAndTextExample), }; 

package/dist/assets/components/menu/menu.types.ts

@@ -1 +1 @@
-import { type OnClickOutsideOptions } from '@/directives/click-outside/types'; import { PopperContainerPosition } from '../popper-container/popper-container.types'; import { type BentoMenuItem } from './components/menu-item/menu-item.types'; import { type HTMLAttributes } from 'vue'; import { type BentoButtonProps } from '../button/button.types'; /** * @deprecated Since v2.0.0. Use string literal instead. */ const BentoMenuPositions = { ...PopperContainerPosition }; type BentoMenuPositions = PopperContainerPosition; export type * from './components/menu-item/menu-item.types'; export enum BentoMenuEvent { BACK = 'back', CLOSE = 'close', OPEN = 'open', } export interface BentoMenuButtonProps { 'aria-label'?: HTMLAttributes['aria-label']; condensed?: boolean; disabled?: boolean; variant?: BentoButtonProps['variant']; } export interface BentoMenuProps { /** * Object containing props to change the menu button appearance. Accepts the same props present in BentoButton. */ button?: BentoMenuButtonProps; /** * Controls if the menu should close when an item is clicked. * Defaults to `true`. */ closeMenuOnItemSelect?: boolean; /** * The data to be displayed in the list */ data: Array<BentoMenuItem>; /** * Disables opening the menu when the down arrow key is pressed. */ disableArrowDownOpeningMenu?: boolean; /** * The position of where the menu should open. */ menuPosition?: BentoMenuPositions | `${BentoMenuPositions}`; /** * Instructs the menu popover to be visible outside of the containing container. * @see {@link https://floating-ui.com/docs/usefloating#strategy} */ menuFixedPositioning?: boolean; /** * Sets a custom width for the menu popover. Values are clamped between 150 - 350. */ menuWidth?: number; /** * Returns focus to the menu button after popover is closed. * Disable if focus management is delegated to the parent component. * Defaults to `true`. */ revertFocusToButton?: boolean; /** * Can be used to set the inner teleport component to render the menu's popover in the root `body` DOM node * (or `dialog` if popover is inside a dialog). */ teleport?: boolean; /** * Can be used to set the inner teleport component to render the menu's popover in the root `body` DOM node * (or `dialog` if popover is inside a dialog). * * @see {@link OnClickOutsideOptions} */ closeOnClickOutsideOptions?: OnClickOutsideOptions; } 
+import { type OnClickOutsideOptions } from '@/directives/click-outside/types'; import { PopperContainerPosition } from '../popper-container/popper-container.types'; import { type BentoMenuItem } from './components/menu-item/menu-item.types'; import { type HTMLAttributes } from 'vue'; import { type BentoButtonProps } from '../button/button.types'; /** * @deprecated Since v3.0.0. Use string literal instead. */ const BentoMenuPositions = { ...PopperContainerPosition }; type BentoMenuPositions = PopperContainerPosition; export type * from './components/menu-item/menu-item.types'; export enum BentoMenuEvent { BACK = 'back', CLOSE = 'close', OPEN = 'open', } export interface BentoMenuButtonProps { 'aria-label'?: HTMLAttributes['aria-label']; condensed?: boolean; disabled?: boolean; variant?: BentoButtonProps['variant']; } export interface BentoMenuProps { /** * Object containing props to change the menu button appearance. Accepts the same props present in BentoButton. */ button?: BentoMenuButtonProps; /** * Controls if the menu should close when an item is clicked. * Defaults to `true`. */ closeMenuOnItemSelect?: boolean; /** * The data to be displayed in the list */ data: Array<BentoMenuItem>; /** * Disables opening the menu when the down arrow key is pressed. */ disableArrowDownOpeningMenu?: boolean; /** * The position of where the menu should open. */ menuPosition?: BentoMenuPositions | `${BentoMenuPositions}`; /** * Instructs the menu popover to be visible outside of the containing container. * @see {@link https://floating-ui.com/docs/usefloating#strategy} */ menuFixedPositioning?: boolean; /** * Sets a custom width for the menu popover. Values are clamped between 150 - 350. */ menuWidth?: number; /** * Returns focus to the menu button after popover is closed. * Disable if focus management is delegated to the parent component. * Defaults to `true`. */ revertFocusToButton?: boolean; /** * Can be used to set the inner teleport component to render the menu's popover in the root `body` DOM node * (or `dialog` if popover is inside a dialog). */ teleport?: boolean; /** * Can be used to set the inner teleport component to render the menu's popover in the root `body` DOM node * (or `dialog` if popover is inside a dialog). * * @see {@link OnClickOutsideOptions} */ closeOnClickOutsideOptions?: OnClickOutsideOptions; } 

package/dist/assets/components/menu/menu.vue

@@ -1 +1 @@
-<template> <div :class="computedClasses" class="b-menu" data-testid="menu" @keydown.down="onKeyDown" @keydown.up="onKeyUp" @keydown.esc="closeMenu()" > <bento-toggle-button ref="menuButtonRef" class="b-menu__toggle-button" aria-haspopup="true" v-bind="computedButtonPropsWithDefaults" :aria-label="computedMenuButtonAriaLabel(hasSlot('default'))" :aria-controls="showMenu ? menuId : null" :toggled="showMenu" :inverse="isInverseColorSet" @click="toggleShowMenu" > <template v-if="!hasSlot('default') || hasSlot('iconLeft')" #iconLeft> <slot name="iconLeft"> <options-vertical-icon aria-hidden="true" /> </slot> </template> <template v-if="hasSlot('default')" #default> <slot /> </template> <template v-if="hasSlot('default')" #iconRight> <chevron-down-icon /> </template> </bento-toggle-button> <bento-teleport v-if="menuButtonRef" :disabled="!teleport"> <bento-popover v-if="menuButtonRef" :id="menuId" ref="popoverRef" :role="null" :open="showMenu" class="b-menu__popover" :style="computedMenuWidth" :target-element="menuButtonRef" :position="menuPosition" :fixed-positioning="menuFixedPositioning" :fallback-position="[ 'bottom-start', 'bottom-end', 'top-start', 'top-end', 'right-start', 'right-end', 'left-start', 'left-end', ]" :teleport="teleport" without-space > <menu-item-list ref="menuItemListRef" :close-menu-on-item-select="closeMenuOnItemSelect" :data="data" :focus-last-element="isLastElementFocused" :popover-width="menuWidth" @close="closeMenu" @menu-item-click="menuItemClick" /> </bento-popover> </bento-teleport> </div> </template> <script setup lang="ts"> import BentoToggleButton from '@/components/button/components/toggle-button/toggle-button.vue'; import { DIVIDER_INVERSE_INJECTION_KEY } from '@/components/divider/divider.keys'; import BentoPopover from '@/components/popover/popover.vue'; import { useClickOutside, useHasSlot } from '@/composables'; import { generateUid } from '@/core/utils/ts'; import { BentoTeleport } from '@/internal/teleport'; import { useI18n } from '@/utils/ts/i18n'; import { printDevelopmentWarning } from '@/utils/ts/print-development-warning'; import ChevronDownIcon from '@adyen/ui-assets-icons-16/vue/chevron-down'; import OptionsVerticalIcon from '@adyen/ui-assets-icons-16/vue/options-vertical'; import { computed, inject, nextTick, onMounted, provide, ref, useSlots } from 'vue'; import MenuItemList from './components/menu-item-list/menu-item-list.vue'; import { MENU_INVERSE_INJECTION_KEY } from './menu.keys'; import { clampMenuWidth } from './composables/use-dynamic-menu-size/use-dynamic-menu-size'; import { type BentoMenuButtonProps, BentoMenuEvent, type BentoMenuProps } from './menu.types'; import messages from './messages.json'; type MessageSchema = (typeof messages)['en-US']; const props = withDefaults(defineProps<BentoMenuProps>(), { button: () => ({ variant: 'secondary', }) as BentoMenuButtonProps, closeMenuOnItemSelect: true, disableArrowDownOpeningMenu: false, menuPosition: 'bottom-start', menuFixedPositioning: false, menuWidth: null, revertFocusToButton: true, teleport: false, closeOnClickOutsideOptions: undefined, }); const emit = defineEmits<{ (e: BentoMenuEvent.CLOSE): void; (e: BentoMenuEvent.OPEN): void; (e: 'menu-item-click'): void; (e: 'click-outside'): void; }>(); const slots = useSlots(); const hasSlot = useHasSlot(slots); const { t } = useI18n<{ message: MessageSchema }>({ messages }); const menuButtonRef = ref(null); const menuItemListRef = ref(null); const showMenu = ref(false); const isLastElementFocused = ref(false); const popoverRef = ref<HTMLElement>(null); const menuId = generateUid('menu'); const isInverseColorSet = inject(MENU_INVERSE_INJECTION_KEY, ref(false)); provide(DIVIDER_INVERSE_INJECTION_KEY, isInverseColorSet); const computedClasses = computed(() => ({ 'b-menu--inverse': isInverseColorSet.value, })); const computedMenuWidth = computed(() => props.menuWidth ? { width: `${clampMenuWidth(props.menuWidth)}px` } : null ); const computedMenuButtonAriaLabel = (hasDefaultSlot: boolean) => { if (props.button?.['aria-label']) { return props.button?.['aria-label']; } if (!hasDefaultSlot) { return t('menuButton'); } return undefined; }; const computedButtonPropsWithDefaults = computed<BentoMenuButtonProps>(() => { if (!props?.button) { return undefined; } return { variant: 'secondary', ...props.button, }; }); const openMenu = () => { showMenu.value = true; emit(BentoMenuEvent.OPEN); }; const closeMenu = async (revertFocus = props.revertFocusToButton) => { if (!showMenu.value) { return; } showMenu.value = false; if (revertFocus) { // ensure that menu is closed and re-rendering is completed before focusing await nextTick(); menuButtonRef.value?.$el?.focus(); } emit(BentoMenuEvent.CLOSE); }; const toggleShowMenu = (e: MouseEvent) => { e.stopPropagation(); if (!showMenu.value) { openMenu(); } else { closeMenu(); } }; const onKeyDown = (event: KeyboardEvent) => { event.preventDefault(); isLastElementFocused.value = false; if (!props.disableArrowDownOpeningMenu) { openMenu(); } }; const onKeyUp = (event: KeyboardEvent) => { event.preventDefault(); isLastElementFocused.value = true; openMenu(); }; const menuItemClick = () => { emit('menu-item-click'); }; // Ignore the events inside the Button and the Popover useClickOutside( popoverRef, () => { closeMenu(); emit('click-outside'); }, { ...props.closeOnClickOutsideOptions, ignore: [menuButtonRef, ...(props.closeOnClickOutsideOptions?.ignore ?? [])], } ); defineExpose({ /** * Control to enable programmatic closing of the menu */ closeMenu, }); onMounted(() => { if (hasSlot('iconRight')) { printDevelopmentWarning( '"bento-menu" no longer supports the "iconRight" slot. The right-aligned icon is now fixed by design.' ); } }); </script> <script lang="ts"> /** * Menu component to render a series of buttons. Csan render nested submenus. * * @example * import { BentoMenu } from '@adyen/bento-vue2'; * * export default { * components: { BentoMenu }, * template: ` * <bento-menu * :data=[ * { text: 'Menu item text', handler: () => { some code here } }, * { text: 'Another menu item text', handler: () => { some other code here }, critical: true } * ] * /> * } */ export default { i18n: { messages }, name: 'bento-menu', }; </script> <style lang="scss" scoped src="./menu.scss" /> 
+<template> <div :class="computedClasses" class="b-menu" data-testid="menu" @keydown.down="onKeyDown" @keydown.up="onKeyUp" @keydown.esc="closeMenu()" > <bento-toggle-button ref="menuButtonRef" class="b-menu__toggle-button" aria-haspopup="true" v-bind="computedButtonPropsWithDefaults" :aria-label="computedMenuButtonAriaLabel(hasSlot('default'))" :aria-controls="showMenu ? menuId : null" :toggled="showMenu" :inverse="isInverseColorSet" @click="toggleShowMenu" > <template v-if="!hasSlot('default') || hasSlot('iconLeft')" #iconLeft> <slot name="iconLeft"> <options-vertical-icon aria-hidden="true" /> </slot> </template> <template v-if="hasSlot('default')" #default> <slot /> </template> <template v-if="hasSlot('default')" #iconRight> <chevron-down-icon /> </template> </bento-toggle-button> <bento-teleport v-if="menuButtonRef" :disabled="!teleport"> <bento-popover v-if="menuButtonRef" :id="menuId" ref="popoverRef" :role="null" :open="showMenu" class="b-menu__popover" :style="computedMenuWidth" :target-element="menuButtonRef" :position="menuPosition" :fixed-positioning="menuFixedPositioning" :fallback-position="[ 'bottom-start', 'bottom-end', 'top-start', 'top-end', 'right-start', 'right-end', 'left-start', 'left-end', ]" :teleport="teleport" without-space > <menu-item-list ref="menuItemListRef" :close-menu-on-item-select="closeMenuOnItemSelect" :data="data" :focus-last-element="isLastElementFocused" :popover-width="menuWidth" @close="closeMenu" @menu-item-click="menuItemClick" /> </bento-popover> </bento-teleport> </div> </template> <script setup lang="ts"> import BentoToggleButton from '@/components/button/components/toggle-button/toggle-button.vue'; import { DIVIDER_INVERSE_INJECTION_KEY } from '@/components/divider/divider.keys'; import BentoPopover from '@/components/popover/popover.vue'; import { useClickOutside, useHasSlot } from '@/composables'; import { generateUid } from '@/utils/ts/generate-uid'; import { BentoTeleport } from '@/internal/teleport'; import { useI18n } from '@/utils/ts/i18n'; import { printDevelopmentWarning } from '@/utils/ts/print-development-warning'; import ChevronDownIcon from '@adyen/ui-assets-icons-16/vue/chevron-down'; import OptionsVerticalIcon from '@adyen/ui-assets-icons-16/vue/options-vertical'; import { computed, inject, nextTick, onMounted, provide, ref, useSlots } from 'vue'; import MenuItemList from './components/menu-item-list/menu-item-list.vue'; import { MENU_INVERSE_INJECTION_KEY } from './menu.keys'; import { clampMenuWidth } from './composables/use-dynamic-menu-size/use-dynamic-menu-size'; import { type BentoMenuButtonProps, BentoMenuEvent, type BentoMenuProps } from './menu.types'; import messages from './messages.json'; type MessageSchema = (typeof messages)['en-US']; const props = withDefaults(defineProps<BentoMenuProps>(), { button: () => ({ variant: 'secondary', }) as BentoMenuButtonProps, closeMenuOnItemSelect: true, disableArrowDownOpeningMenu: false, menuPosition: 'bottom-start', menuFixedPositioning: false, menuWidth: null, revertFocusToButton: true, teleport: false, closeOnClickOutsideOptions: undefined, }); const emit = defineEmits<{ (e: BentoMenuEvent.CLOSE): void; (e: BentoMenuEvent.OPEN): void; (e: 'menu-item-click'): void; (e: 'click-outside'): void; }>(); const slots = useSlots(); const hasSlot = useHasSlot(slots); const { t } = useI18n<{ message: MessageSchema }>({ messages }); const menuButtonRef = ref(null); const menuItemListRef = ref(null); const showMenu = ref(false); const isLastElementFocused = ref(false); const popoverRef = ref<HTMLElement>(null); const menuId = generateUid('menu'); const isInverseColorSet = inject(MENU_INVERSE_INJECTION_KEY, ref(false)); provide(DIVIDER_INVERSE_INJECTION_KEY, isInverseColorSet); const computedClasses = computed(() => ({ 'b-menu--inverse': isInverseColorSet.value, })); const computedMenuWidth = computed(() => props.menuWidth ? { width: `${clampMenuWidth(props.menuWidth)}px` } : null ); const computedMenuButtonAriaLabel = (hasDefaultSlot: boolean) => { if (props.button?.['aria-label']) { return props.button?.['aria-label']; } if (!hasDefaultSlot) { return t('menuButton'); } return undefined; }; const computedButtonPropsWithDefaults = computed<BentoMenuButtonProps>(() => { if (!props?.button) { return undefined; } return { variant: 'secondary', ...props.button, }; }); const openMenu = () => { showMenu.value = true; emit(BentoMenuEvent.OPEN); }; const closeMenu = async (revertFocus = props.revertFocusToButton) => { if (!showMenu.value) { return; } showMenu.value = false; if (revertFocus) { // ensure that menu is closed and re-rendering is completed before focusing await nextTick(); menuButtonRef.value?.$el?.focus(); } emit(BentoMenuEvent.CLOSE); }; const toggleShowMenu = (e: MouseEvent) => { e.stopPropagation(); if (!showMenu.value) { openMenu(); } else { closeMenu(); } }; const onKeyDown = (event: KeyboardEvent) => { event.preventDefault(); isLastElementFocused.value = false; if (!props.disableArrowDownOpeningMenu) { openMenu(); } }; const onKeyUp = (event: KeyboardEvent) => { event.preventDefault(); isLastElementFocused.value = true; openMenu(); }; const menuItemClick = () => { emit('menu-item-click'); }; // Ignore the events inside the Button and the Popover useClickOutside( popoverRef, () => { closeMenu(); emit('click-outside'); }, { ...props.closeOnClickOutsideOptions, ignore: [menuButtonRef, ...(props.closeOnClickOutsideOptions?.ignore ?? [])], } ); defineExpose({ /** * Control to enable programmatic closing of the menu */ closeMenu, }); onMounted(() => { if (hasSlot('iconRight')) { printDevelopmentWarning( '"bento-menu" no longer supports the "iconRight" slot. The right-aligned icon is now fixed by design.' ); } }); </script> <script lang="ts"> /** * Menu component to render a series of buttons. Csan render nested submenus. * * @example * import { BentoMenu } from '@adyen/bento-vue2'; * * export default { * components: { BentoMenu }, * template: ` * <bento-menu * :data=[ * { text: 'Menu item text', handler: () => { some code here } }, * { text: 'Another menu item text', handler: () => { some other code here }, critical: true } * ] * /> * } */ export default { i18n: { messages }, name: 'bento-menu', }; </script> <style lang="scss" scoped src="./menu.scss" /> 

package/dist/assets/components/modal/components/base-modal/base-modal.vue

@@ -1 +1 @@
-<template> <div class="b-modal-base"> <dialog ref="modal" :role="modalRole" :aria-label="computedAriaLabel" :style="{ height: height }" class="b-modal-base__container" :class="modalConditionalClasses" :open="initiallyOpen" @animationend="closeModalAfterAnimation" @keydown.esc="internalModalActionClose" > <bento-focus-trap v-if="isOpen || initiallyOpen" :id="modalId" v-bento-click-outside-directive="closeModalOnClickOutside" > <bento-button v-if="showCloseButton" class="b-modal-base__close-button" variant="tertiary" type="button" :style="customPaddingStyles" @click="internalModalActionClose" > <cross-icon :svg-title="t('close')" /> </bento-button> <template v-if="props.activePage"> <slot /> </template> <bento-modal-page v-else :with-column-layout="withColumnLayout" :size="size" :custom-padding="customPadding" :columns-size="columnsSize" > <template v-if="hasSlot('default')" #default> <slot></slot> </template> <template v-if="hasSlot('content-col-1')" #content-col-1 ><slot name="content-col-1"></slot ></template> <template v-if="hasSlot('content-col-2')" #content-col-2 ><slot name="content-col-2"></slot ></template> <template v-if="hasSlot('content')" #content><slot name="content"></slot></template> <template v-if="hasSlot('actions')" #actions><slot name="actions"></slot></template> </bento-modal-page> </bento-focus-trap> </dialog> </div> </template> <script setup lang="ts"> import { computed, defineComponent, onMounted, type PropType, provide, ref, toRefs, useAttrs, useSlots, watch, } from 'vue'; import { BentoModalColumnLayoutVariant, type BentoModalConfigData, BentoModalRole, BentoModalSize, } from '@/components/modal/modal.types'; import { BentoButton, type BentoButtonActionsList } from '@/components/button'; import { BentoFocusTrap } from '@/components/focus-trap'; import { useHasSlot } from '@/composables'; import { useI18n } from '@/utils/ts/i18n'; import { MODAL_DIALOG_ID_INJECTION_KEY } from '@/components/modal/components/base-modal/base-modal.keys'; import { generateUid } from '@/core/utils/ts'; import { BentoClickOutsideDirective as vBentoClickOutsideDirective } from '@/directives/click-outside'; import messages from './messages.json'; import { BentoModalPage } from '@/components/modal/components/modal-page'; import CrossIcon from '@adyen/ui-assets-icons-16/vue/cross'; import { MODAL_CONFIG_INJECTION_KEY } from '../../modal.keys'; import { BentoDialogPageAnimation, type BentoDialogPageConfigData, type BentoDialogPageRegisterPage, DIALOG_PAGE_CONFIG_INJECTION_KEY, DIALOG_PAGE_REGISTER_PAGE_INJECTION_KEY, } from '@/internal'; type MessageSchema = (typeof messages)['en-US']; const LOADING_BTN_CLOSE_AFTER_SUCCESS_DELAY_TIME = 500; const { t } = useI18n<{ message: MessageSchema }>({ messages }); const slots = useSlots(); const attrs = useAttrs(); const hasSlot = useHasSlot(slots); const modal = ref<HTMLDialogElement>(null); const isClosing = ref(false); const modalId = generateUid('modal'); const emit = defineEmits<{ /** * Emits update event when page is changed internally */ (e: 'update:active-page', page: string): void; /** * Emitted when the modal is closed. */ (e: 'close-modal'); }>(); const props = defineProps({ /** * List of actions that will be used to render the buttons. * First element in the list will be rendered as "primary". * All elements after the first will be rendered as "secondary". * But you may change the color of 1-st action to red with 'critial' key * Not more than 3 action buttons can be provided * Or 2 action buttons and 1 Label for them * * Each object in the list should have a `title`, an `event` and * (optional) a Vue `icon` from the library `@adyen/ui-assets-icons-16`. * * `title`: Button's text. * * `event`: Event triggered when clicking the Button. * * `icon`: Vue Icon from the library `@adyen/ui-assets-icons-16`. * * ``` * [{ * title: 'Primary',2 * event: () => { ... }, * icon: FourPeopleIcon * }, { * title: 'Secondary', * event: () => { ... } * }] * ``` */ actions: { type: Array as PropType<BentoButtonActionsList>, default: null, }, /** * The id of the current active page * Should be the same id as the BentoModalPage to be displayed */ activePage: { type: String, default: null, }, /** * If a column layout is provided, it renders the respective left column width variant. This can be smaller than the second column, the same size as the second column or bigger than the second column. */ columnsSize: { type: String as PropType<BentoModalColumnLayoutVariant>, default: BentoModalColumnLayoutVariant.SMALLER, }, /** * If provided, manages the padding of the whole modal container */ customPadding: { type: String, default: null }, /** * If passed - sets first button color to red */ destructiveActions: { type: Boolean, default: false }, /** * Hides a cross icon on the right side of the title */ hideCloseButton: { type: Boolean, required: true }, /** * Sets the open attribute on the dialog element, use isOpen instead to toggle modal visbility. */ initiallyOpen: { type: Boolean, default: false }, /** * If set to true, it allows the modal to be closed by clicking outside of it */ isDismissible: { type: Boolean, required: true }, /** * Controls the modal's state from the outside. Set it to true to open the modal */ isOpen: { type: Boolean, required: true }, /** * Defines whether the modal will be an alert modal */ modalRole: { type: String, default: BentoModalRole.DIALOG }, /** * Sets the width of the modal */ size: { type: String as PropType<BentoModalSize | `${BentoModalSize}`>, default: BentoModalSize.SMALL, }, /** * If provided, renders the modal's content in a two-column layout an wth dividers separating its content */ withColumnLayout: { type: Boolean, default: false }, }); const showCloseButton = computed(() => props.isDismissible && !props.hideCloseButton); const pageCustomPadding = ref(props.customPadding); const customPaddingStyles = computed(() => { if (!pageCustomPadding.value) { return {}; } return { top: pageCustomPadding.value, right: pageCustomPadding.value }; }); const computedAriaLabel = computed(() => (attrs['aria-label'] as string) ?? (t('ariaLabelFallback') as string)); const hasColumnLayout = computed(() => props.withColumnLayout && props.size === BentoModalSize.LARGE); const openModal = (): void => { modal.value.showModal(); }; const emitCloseEvent = (): void => { emit('close-modal'); }; // Handle closing and closing animation for dialog element const closeModalAfterAnimation = () => { if (isClosing.value && modal.value) { modal.value.close(); if (previousPages.value[0]) { emit('update:active-page', previousPages.value[0]); } previousPages.value = []; isClosing.value = false; emitCloseEvent(); } }; const startCloseModalAnimation = () => { if (!modal.value.open) { return; } isClosing.value = true; }; /** * If the user has pressed escape, clicked outside or clicked the close icon. * Needs to be called from outside, following the "dialog.close()" pattern, * when the closing event is triggered outside of the "base-modal" * component (e.g. from a closing action). */ const internalModalActionClose = (event?: Event) => { if (event) { event.preventDefault(); } if (!props.isDismissible && props.modalRole === BentoModalRole.DIALOG) { return; } startCloseModalAnimation(); }; const closeModalOnClickOutside = () => { if (props.isDismissible) { internalModalActionClose(); } }; const modalConditionalClasses = computed(() => ({ [`b-modal-base__container--${props.size}`]: props.size, 'b-modal-base__container--hide': isClosing.value, 'b-modal-base__container--column-layout': hasColumnLayout.value, 'b-modal-base__container--animation': isAnimationActive.value, })); watch( () => [props.isOpen, modal.value], ([newIsOpen, newModalValue], [, oldModalValue]): void => { if (!newModalValue) { return; } const isFirstMutation = !oldModalValue; if (newIsOpen) { openModal(); // add the first page to the array when the modal opens if (!previousPages.value.length) { previousPages.value.push(activePage.value); } } else if (!isFirstMutation) { startCloseModalAnimation(); } } ); // If the first button is a loading button then close the modal have 0.5 seconds // if the state is changed to 'success'. watch( () => props.actions, () => { if (props.actions?.[0]?.state === 'success') { setTimeout(startCloseModalAnimation, LOADING_BTN_CLOSE_AFTER_SUCCESS_DELAY_TIME); } }, { deep: true } ); onMounted(() => { if (props.isOpen && modal.value) { openModal(); } }); /** * Expose methods through its 'ref' */ defineExpose({ internalModalActionClose, }); // Let's Children components know they are inside a Modal (dialog element) provide(MODAL_DIALOG_ID_INJECTION_KEY, modalId); // Modal pagination const { activePage, isOpen, size } = toRefs(props); const animation = ref(BentoDialogPageAnimation.TRANSITION_LEVEL_DEEPER); const pages = ref<Array<string>>([]); const previousPages = ref([]); const updatePage = page => emit('update:active-page', page); // unregister page if removed / destroyed const unregisterPage = (pageIdToRemove: string) => () => { pages.value = pages.value?.filter(pageId => pageId !== pageIdToRemove); }; // Provide data and function to register page to subcomponent const registerPage: BentoDialogPageRegisterPage = pageId => { if (pageId) { pages.value.push(pageId); } return { unregisterPage: unregisterPage(pageId) }; }; const height = ref(''); const isAnimationActive = ref(false); provide<BentoModalConfigData>(MODAL_CONFIG_INJECTION_KEY, { activePage, height, isAnimationActive, pageCustomPadding, showCloseButton, size, }); provide<BentoDialogPageConfigData>(DIALOG_PAGE_CONFIG_INJECTION_KEY, { activePage, animation, isOpen, pages, previousPages, updatePage, }); provide(DIALOG_PAGE_REGISTER_PAGE_INJECTION_KEY, registerPage); </script> <script lang="ts"> /** * Dialog container. It creates a dialog HTML element for the modal to use. * * @example * import BaseModal from './components/base-modal/base-modal.vue'; * * export default { * components: { BaseModal }, * template: ` * <base-modal * :hide-close-button="true" * :is-dismissible="false" * :is-open="isOpen" * @close-modal="isOpen = false" * > * <template #content-col-1> * // Content on the left side column * </template> * * <template #content-col-2> * // Content on the right side column * </template> * * <template v-if="actions" #actions> * <footer-actions :actions="actions" /> * </template> * </base-modal> * `, * setup() { * const isOpen = ref(true) * const footerActions = [{ * title: 'Primary action', * event: () => { ... } * }] * } * } */ export default defineComponent({ i18n: { messages }, name: 'base-modal', }); </script> <style lang="scss" scoped src="./base-modal.scss" /> 
+<template> <div v-bind="getRootAttributes($attrs)" class="b-modal-base"> <dialog ref="modal" :role="modalRole" :aria-label="$attrs?.['aria-label'] ?? t('ariaLabelFallback')" :style="{ height: height }" class="b-modal-base__container" :class="modalConditionalClasses" :open="initiallyOpen" @animationend="closeModalAfterAnimation" @keydown.esc="internalModalActionClose" > <bento-focus-trap v-if="isOpen || initiallyOpen" :id="modalId" v-bento-click-outside-directive="closeModalOnClickOutside" > <bento-button v-if="showCloseButton" class="b-modal-base__close-button" variant="tertiary" type="button" :style="customPaddingStyles" @click="internalModalActionClose" > <cross-icon :svg-title="t('close')" /> </bento-button> <template v-if="props.activePage"> <slot /> </template> <bento-modal-page v-else :with-column-layout="withColumnLayout" :size="size" :custom-padding="customPadding" :columns-size="columnsSize" > <template v-if="hasSlot('default')" #default> <slot></slot> </template> <template v-if="hasSlot('content-col-1')" #content-col-1 ><slot name="content-col-1"></slot ></template> <template v-if="hasSlot('content-col-2')" #content-col-2 ><slot name="content-col-2"></slot ></template> <template v-if="hasSlot('content')" #content><slot name="content"></slot></template> <template v-if="hasSlot('actions')" #actions><slot name="actions"></slot></template> </bento-modal-page> </bento-focus-trap> </dialog> </div> </template> <script setup lang="ts"> import { computed, defineComponent, onMounted, type PropType, provide, ref, toRefs, useSlots, watch } from 'vue'; import { BentoModalColumnLayoutVariant, BentoModalRole, BentoModalSize } from '@/components/modal/modal.types'; import { type BentoModalConfigData } from '@/components/modal/modal.internal.types'; import { BentoButton, type BentoButtonActionsList } from '@/components/button'; import { BentoFocusTrap } from '@/components/focus-trap'; import { useAttributeRouting, useHasSlot } from '@/composables'; import { useI18n } from '@/utils/ts/i18n'; import { MODAL_DIALOG_ID_INJECTION_KEY } from '@/components/modal/components/base-modal/base-modal.keys'; import { generateUid } from '@/utils/ts/generate-uid'; import { BentoClickOutsideDirective as vBentoClickOutsideDirective } from '@/directives/click-outside'; import messages from './messages.json'; import { BentoModalPage } from '@/components/modal/components/modal-page'; import CrossIcon from '@adyen/ui-assets-icons-16/vue/cross'; import { MODAL_CONFIG_INJECTION_KEY } from '../../modal.keys'; import { BentoDialogPageAnimation, type BentoDialogPageConfigData, type BentoDialogPageRegisterPage, DIALOG_PAGE_CONFIG_INJECTION_KEY, DIALOG_PAGE_REGISTER_PAGE_INJECTION_KEY, } from '@/internal'; type MessageSchema = (typeof messages)['en-US']; const LOADING_BTN_CLOSE_AFTER_SUCCESS_DELAY_TIME = 500; const { t } = useI18n<{ message: MessageSchema }>({ messages }); const { getRootAttributes } = useAttributeRouting(); const slots = useSlots(); const hasSlot = useHasSlot(slots); const modal = ref<HTMLDialogElement>(null); const isClosing = ref(false); const modalId = generateUid('modal'); const emit = defineEmits<{ /** * Emits update event when page is changed internally */ (e: 'update:active-page', page: string): void; /** * Emitted when the modal is closed. */ (e: 'close-modal'); }>(); const props = defineProps({ /** * List of actions that will be used to render the buttons. * First element in the list will be rendered as "primary". * All elements after the first will be rendered as "secondary". * But you may change the color of 1-st action to red with 'critial' key * Not more than 3 action buttons can be provided * Or 2 action buttons and 1 Label for them * * Each object in the list should have a `title`, an `event` and * (optional) a Vue `icon` from the library `@adyen/ui-assets-icons-16`. * * `title`: Button's text. * * `event`: Event triggered when clicking the Button. * * `icon`: Vue Icon from the library `@adyen/ui-assets-icons-16`. * * ``` * [{ * title: 'Primary',2 * event: () => { ... }, * icon: FourPeopleIcon * }, { * title: 'Secondary', * event: () => { ... } * }] * ``` */ actions: { type: Array as PropType<BentoButtonActionsList>, default: null, }, /** * The id of the current active page * Should be the same id as the BentoModalPage to be displayed */ activePage: { type: String, default: null, }, /** * If a column layout is provided, it renders the respective left column width variant. This can be smaller than the second column, the same size as the second column or bigger than the second column. */ columnsSize: { type: String as PropType<BentoModalColumnLayoutVariant>, default: BentoModalColumnLayoutVariant.SMALLER, }, /** * If provided, manages the padding of the whole modal container */ customPadding: { type: String, default: null }, /** * If passed - sets first button color to red */ destructiveActions: { type: Boolean, default: false }, /** * Hides a cross icon on the right side of the title */ hideCloseButton: { type: Boolean, required: true }, /** * Sets the open attribute on the dialog element, use isOpen instead to toggle modal visbility. */ initiallyOpen: { type: Boolean, default: false }, /** * If set to true, it allows the modal to be closed by clicking outside of it */ isDismissible: { type: Boolean, required: true }, /** * Controls the modal's state from the outside. Set it to true to open the modal */ isOpen: { type: Boolean, required: true }, /** * Defines whether the modal will be an alert modal */ modalRole: { type: String, default: BentoModalRole.DIALOG }, /** * Sets the width of the modal */ size: { type: String as PropType<BentoModalSize | `${BentoModalSize}`>, default: BentoModalSize.SMALL, }, /** * If provided, renders the modal's content in a two-column layout an wth dividers separating its content */ withColumnLayout: { type: Boolean, default: false }, }); const showCloseButton = computed(() => props.isDismissible && !props.hideCloseButton); const pageCustomPadding = ref(props.customPadding); const customPaddingStyles = computed(() => { if (!pageCustomPadding.value) { return {}; } return { top: pageCustomPadding.value, right: pageCustomPadding.value }; }); const hasColumnLayout = computed(() => props.withColumnLayout && props.size === BentoModalSize.LARGE); const openModal = (): void => { modal.value.showModal(); }; const emitCloseEvent = (): void => { emit('close-modal'); }; // Handle closing and closing animation for dialog element const closeModalAfterAnimation = () => { if (isClosing.value && modal.value) { modal.value.close(); if (previousPages.value[0]) { emit('update:active-page', previousPages.value[0]); } previousPages.value = []; isClosing.value = false; emitCloseEvent(); } }; const startCloseModalAnimation = () => { if (!modal.value.open) { return; } isClosing.value = true; }; /** * If the user has pressed escape, clicked outside or clicked the close icon. * Needs to be called from outside, following the "dialog.close()" pattern, * when the closing event is triggered outside of the "base-modal" * component (e.g. from a closing action). */ const internalModalActionClose = (event?: Event) => { if (event) { event.preventDefault(); } if (!props.isDismissible && props.modalRole === BentoModalRole.DIALOG) { return; } startCloseModalAnimation(); }; const closeModalOnClickOutside = () => { if (props.isDismissible) { internalModalActionClose(); } }; const modalConditionalClasses = computed(() => ({ [`b-modal-base__container--${props.size}`]: props.size, 'b-modal-base__container--hide': isClosing.value, 'b-modal-base__container--column-layout': hasColumnLayout.value, 'b-modal-base__container--animation': isAnimationActive.value, })); watch( () => [props.isOpen, modal.value], ([newIsOpen, newModalValue], [, oldModalValue]): void => { if (!newModalValue) { return; } const isFirstMutation = !oldModalValue; if (newIsOpen) { openModal(); // add the first page to the array when the modal opens if (!previousPages.value.length) { previousPages.value.push(activePage.value); } } else if (!isFirstMutation) { startCloseModalAnimation(); } } ); // If the first button is a loading button then close the modal have 0.5 seconds // if the state is changed to 'success'. watch( () => props.actions, () => { if (props.actions?.[0]?.state === 'success') { setTimeout(startCloseModalAnimation, LOADING_BTN_CLOSE_AFTER_SUCCESS_DELAY_TIME); } }, { deep: true } ); onMounted(() => { if (props.isOpen && modal.value) { openModal(); } }); /** * Expose methods through its 'ref' */ defineExpose({ internalModalActionClose, }); // Let's Children components know they are inside a Modal (dialog element) provide(MODAL_DIALOG_ID_INJECTION_KEY, modalId); // Modal pagination const { activePage, isOpen, size } = toRefs(props); const animation = ref(BentoDialogPageAnimation.TRANSITION_LEVEL_DEEPER); const pages = ref<Array<string>>([]); const previousPages = ref([]); const updatePage = page => emit('update:active-page', page); // unregister page if removed / destroyed const unregisterPage = (pageIdToRemove: string) => () => { pages.value = pages.value?.filter(pageId => pageId !== pageIdToRemove); }; // Provide data and function to register page to subcomponent const registerPage: BentoDialogPageRegisterPage = pageId => { if (pageId) { pages.value.push(pageId); } return { unregisterPage: unregisterPage(pageId) }; }; const height = ref(''); const isAnimationActive = ref(false); provide<BentoModalConfigData>(MODAL_CONFIG_INJECTION_KEY, { activePage, height, isAnimationActive, pageCustomPadding, showCloseButton, size, }); provide<BentoDialogPageConfigData>(DIALOG_PAGE_CONFIG_INJECTION_KEY, { activePage, animation, isOpen, pages, previousPages, updatePage, }); provide(DIALOG_PAGE_REGISTER_PAGE_INJECTION_KEY, registerPage); </script> <script lang="ts"> /** * Dialog container. It creates a dialog HTML element for the modal to use. * * @example * import BaseModal from './components/base-modal/base-modal.vue'; * * export default { * components: { BaseModal }, * template: ` * <base-modal * :hide-close-button="true" * :is-dismissible="false" * :is-open="isOpen" * @close-modal="isOpen = false" * > * <template #content-col-1> * // Content on the left side column * </template> * * <template #content-col-2> * // Content on the right side column * </template> * * <template v-if="actions" #actions> * <footer-actions :actions="actions" /> * </template> * </base-modal> * `, * setup() { * const isOpen = ref(true) * const footerActions = [{ * title: 'Primary action', * event: () => { ... } * }] * } * } */ export default defineComponent({ i18n: { messages }, name: 'base-modal', inheritAttrs: false, }); </script> <style lang="scss" scoped src="./base-modal.scss" /> 

package/dist/assets/components/modal/components/modal-page/modal-page.vue

@@ -1 +1 @@
-<template> <dialog-page ref="page" class="b-modal-page" :class="modalPageConditionalClasses" :page-id="pageId" :always-show-border="hasColumnLayout" :back-button-styling="customPaddingStyles?.backButton" :previous-page="previousPage" @animationend="isAnimationActive = false" > <template v-if="hasSlot('default') || showCloseButton" #header> <div class="b-modal-page__header-container" :style="customPaddingStyles.header"> <div class="b-modal-page__header"> <bento-typography class="b-modal-page__title" el="span" variant="title" stronger> <slot v-if="hasSlot('default')" /> </bento-typography> </div> </div> </template> <template #content> <div class="b-modal-page__content" :class="modalContentConditionalClasses" :style="customPaddingStyles.content" > <bento-typography v-if="hasSlot('content') || (hasSlot('content-col-1') && hasSlot('content-col-2'))" el="div" > <grid-layout v-if="hasColumnLayout" :column-width="computedColumnWidth" :container-type="GridLayoutContainerType.NORMAL" no-gap class="b-modal-page__grid" > <template #col-1><slot name="content-col-1"></slot></template> <template #col-2><slot name="content-col-2"></slot></template> </grid-layout> <slot v-else name="content" /> </bento-typography> </div> </template> <template v-if="hasSlot('actions')" #footer> <div class="b-modal-page__actions-container" :style="customPaddingStyles.actions"> <div aria-label="modal actions" class="b-modal-page__actions"> <slot name="actions" /> </div> </div> </template> <template v-else-if="actions && actions.length > 0" #footer> <div class="b-modal-page__actions-container" :style="customPaddingStyles.actions"> <footer-actions :actions="actions" :actions-label="actionsLabel" :destructive-actions="destructiveActions" /> </div> </template> </dialog-page> </template> <script setup lang="ts"> import { computed, defineComponent, inject, nextTick, onUnmounted, ref, useSlots, watch } from 'vue'; import { BentoModalColumnLayoutVariant, type BentoModalConfigData, BentoModalSize, } from '@/components/modal/modal.types'; import { BentoTypography } from '@/components/typography'; import { GridLayout, GridLayoutContainerType } from '@/internal'; import { useHasSlot } from '@/composables'; import { FooterActions } from '@/components/internal/footer-actions'; import DialogPage from '@/internal/dialog-page/dialog-page.vue'; import { MODAL_CONFIG_INJECTION_KEY } from '../../modal.keys'; import { observeSizeOfElement } from '@/utils/ts/resize'; import type { BentoModalPageProps } from './modal-page.types'; const CLOSE_BUTTON_ICON_WIDTH = 26; const slots = useSlots(); const hasSlot = useHasSlot(slots); const page = ref<InstanceType<typeof DialogPage>>(null); const props = withDefaults(defineProps<BentoModalPageProps>(), { actions: null, actionsLabel: null, columnsSize: BentoModalColumnLayoutVariant.SMALLER, customPadding: null, destructiveActions: false, withColumnLayout: false, pageId: undefined, previousPage: undefined, }); const modalPageConditionalClasses = computed(() => ({ 'b-modal-page--custom-padding': props.customPadding, })); const modalContentConditionalClasses = computed(() => ({ 'b-modal-page__content--with-header': hasSlot('default'), 'b-modal-page__content--with-actions': hasSlot('actions') || props.actions?.length, })); // Setting custom padding styles const customPaddingStyles = computed(() => { if (!props.customPadding) { return {}; } const xPadding = { paddingLeft: props.customPadding, paddingRight: props.customPadding, }; const content = { ...xPadding, paddingTop: undefined, paddingBottom: undefined }; if (!hasSlot('default')) { content.paddingTop = props.customPadding; } if (!hasSlot('actions')) { content.paddingBottom = props.customPadding; } return { header: { ...xPadding, paddingTop: props.customPadding, paddingRight: `${parseInt(props.customPadding, 10) + CLOSE_BUTTON_ICON_WIDTH}px`, flex: 1, }, content, actions: { ...xPadding, paddingBottom: props.customPadding }, backButton: { top: props.customPadding, paddingLeft: props.customPadding }, }; }); // Column layout styles const hasColumnLayout = computed(() => props.withColumnLayout && size.value === BentoModalSize.LARGE); const computedColumnWidth = computed(() => { if (props.columnsSize === BentoModalColumnLayoutVariant.SMALLER) { return [ { small: 4, medium: 4, large: 4 }, { small: 8, medium: 8, large: 8 }, ]; } if (props.columnsSize === BentoModalColumnLayoutVariant.BIGGER) { return [ { small: 8, medium: 8, large: 8 }, { small: 4, medium: 4, large: 4 }, ]; } return [ { small: 6, medium: 6, large: 6 }, { small: 6, medium: 6, large: 6 }, ]; }); // Register page to parent component and inject data from parent component const { activePage, height, isAnimationActive, pageCustomPadding, showCloseButton, size } = inject<BentoModalConfigData>(MODAL_CONFIG_INJECTION_KEY); const isCurrentPage = computed(() => activePage.value === props.pageId || !activePage.value); // Animation // Set resize observer on mount of update the height of the dialog on resize let pageElementObserver: ResizeObserver | null = null; // Watching activePage changes to set the height of the page and set isAnimationActive watch( () => activePage.value, async (value, oldValue) => { if (isCurrentPage.value) { await nextTick(); height.value = `${page.value?.$el?.clientHeight}px`; pageCustomPadding.value = props.customPadding; // only set isAnimationActive to true if its going from two different pages and not from null to the first page isAnimationActive.value = oldValue !== undefined; pageElementObserver = observeSizeOfElement(page.value, () => { const pageHeight = `${page.value?.$el?.clientHeight}px`; if (pageHeight && pageHeight !== height.value) { height.value = pageHeight; } }); } }, { immediate: true } ); // Disconnect observer on unmounting the page onUnmounted(() => { pageElementObserver?.disconnect(); }); </script> <script lang="ts"> /** * ModalPage is used to render different pages of the Modal component * * @example * import { BentoModal, BentoModalPage } from '@adyen/bento-vue2'; * * export default { * components: { BentoModal, BentoModalPage }, * template: ` * <bento-modal active-page='page1' :is-open='true'> * <bento-modal-page * pageId='page1' * actions-label='Move to next page' * :actions="[ * { * title: 'Next page', * event: () => { * activePage.value = 'page2'; * }, * }]"> * Page 1 * <template #content> * Page 1 content * </template> * </bento-modal-page> * <bento-modal-page * pageId='page2' * :actions="[ * { * title: 'Save', * event: () => {}, * }]"> * Page 2 * <template #content> * Page 2 content * </template> * </bento-modal-page> * </bento-modal> * ` * } */ export default defineComponent({}); </script> <style lang="scss" scoped src="./modal-page.scss" /> 
+<template> <dialog-page ref="page" class="b-modal-page" :class="modalPageConditionalClasses" :page-id="pageId" :always-show-border="hasColumnLayout" :back-button-styling="customPaddingStyles?.backButton" :previous-page="previousPage" @animationend="isAnimationActive = false" > <template v-if="hasSlot('default') || showCloseButton" #header> <div class="b-modal-page__header-container" :style="customPaddingStyles.header"> <div class="b-modal-page__header"> <bento-typography class="b-modal-page__title" el="span" variant="title" stronger> <slot v-if="hasSlot('default')" /> </bento-typography> </div> </div> </template> <template #content> <div class="b-modal-page__content" :class="modalContentConditionalClasses" :style="customPaddingStyles.content" > <bento-typography v-if="hasSlot('content') || (hasSlot('content-col-1') && hasSlot('content-col-2'))" el="div" > <grid-layout v-if="hasColumnLayout" :column-width="computedColumnWidth" :container-type="GridLayoutContainerType.NORMAL" no-gap class="b-modal-page__grid" > <template #col-1><slot name="content-col-1"></slot></template> <template #col-2><slot name="content-col-2"></slot></template> </grid-layout> <slot v-else name="content" /> </bento-typography> </div> </template> <template v-if="hasSlot('actions')" #footer> <div class="b-modal-page__actions-container" :style="customPaddingStyles.actions"> <div aria-label="modal actions" class="b-modal-page__actions"> <slot name="actions" /> </div> </div> </template> <template v-else-if="actions && actions.length > 0" #footer> <div class="b-modal-page__actions-container" :style="customPaddingStyles.actions"> <footer-actions :actions="actions" :actions-label="actionsLabel" :destructive-actions="destructiveActions" /> </div> </template> </dialog-page> </template> <script setup lang="ts"> import { computed, defineComponent, inject, nextTick, onUnmounted, ref, useSlots, watch } from 'vue'; import { BentoModalColumnLayoutVariant, BentoModalSize } from '@/components/modal/modal.types'; import { type BentoModalConfigData } from '@/components/modal/modal.internal.types'; import { BentoTypography } from '@/components/typography'; import { GridLayout, GridLayoutContainerType } from '@/internal'; import { useHasSlot } from '@/composables'; import { FooterActions } from '@/components/internal/footer-actions'; import DialogPage from '@/internal/dialog-page/dialog-page.vue'; import { MODAL_CONFIG_INJECTION_KEY } from '../../modal.keys'; import { observeSizeOfElement } from '@/utils/ts/resize'; import type { BentoModalPageProps } from './modal-page.types'; const CLOSE_BUTTON_ICON_WIDTH = 26; const slots = useSlots(); const hasSlot = useHasSlot(slots); const page = ref<InstanceType<typeof DialogPage>>(null); const props = withDefaults(defineProps<BentoModalPageProps>(), { actions: null, actionsLabel: null, columnsSize: BentoModalColumnLayoutVariant.SMALLER, customPadding: null, destructiveActions: false, withColumnLayout: false, pageId: undefined, previousPage: undefined, }); const modalPageConditionalClasses = computed(() => ({ 'b-modal-page--custom-padding': props.customPadding, })); const modalContentConditionalClasses = computed(() => ({ 'b-modal-page__content--with-header': hasSlot('default'), 'b-modal-page__content--with-actions': hasSlot('actions') || props.actions?.length, })); // Setting custom padding styles const customPaddingStyles = computed(() => { if (!props.customPadding) { return {}; } const xPadding = { paddingLeft: props.customPadding, paddingRight: props.customPadding, }; const content = { ...xPadding, paddingTop: undefined, paddingBottom: undefined }; if (!hasSlot('default')) { content.paddingTop = props.customPadding; } if (!hasSlot('actions')) { content.paddingBottom = props.customPadding; } return { header: { ...xPadding, paddingTop: props.customPadding, paddingRight: `${parseInt(props.customPadding, 10) + CLOSE_BUTTON_ICON_WIDTH}px`, flex: 1, }, content, actions: { ...xPadding, paddingBottom: props.customPadding }, backButton: { top: props.customPadding, paddingLeft: props.customPadding }, }; }); // Column layout styles const hasColumnLayout = computed(() => props.withColumnLayout && size.value === BentoModalSize.LARGE); const computedColumnWidth = computed(() => { if (props.columnsSize === BentoModalColumnLayoutVariant.SMALLER) { return [ { small: 4, medium: 4, large: 4 }, { small: 8, medium: 8, large: 8 }, ]; } if (props.columnsSize === BentoModalColumnLayoutVariant.BIGGER) { return [ { small: 8, medium: 8, large: 8 }, { small: 4, medium: 4, large: 4 }, ]; } return [ { small: 6, medium: 6, large: 6 }, { small: 6, medium: 6, large: 6 }, ]; }); // Register page to parent component and inject data from parent component const { activePage, height, isAnimationActive, pageCustomPadding, showCloseButton, size } = inject<BentoModalConfigData>(MODAL_CONFIG_INJECTION_KEY); const isCurrentPage = computed(() => activePage.value === props.pageId || !activePage.value); // Animation // Set resize observer on mount of update the height of the dialog on resize let pageElementObserver: ResizeObserver | null = null; // Watching activePage changes to set the height of the page and set isAnimationActive watch( () => activePage.value, async (value, oldValue) => { if (isCurrentPage.value) { await nextTick(); height.value = `${page.value?.$el?.clientHeight}px`; pageCustomPadding.value = props.customPadding; // only set isAnimationActive to true if its going from two different pages and not from null to the first page isAnimationActive.value = oldValue !== undefined; pageElementObserver = observeSizeOfElement(page.value, () => { const pageHeight = `${page.value?.$el?.clientHeight}px`; if (pageHeight && pageHeight !== height.value) { height.value = pageHeight; } }); } }, { immediate: true } ); // Disconnect observer on unmounting the page onUnmounted(() => { pageElementObserver?.disconnect(); }); </script> <script lang="ts"> /** * ModalPage is used to render different pages of the Modal component * * @example * import { BentoModal, BentoModalPage } from '@adyen/bento-vue2'; * * export default { * components: { BentoModal, BentoModalPage }, * template: ` * <bento-modal active-page='page1' :is-open='true'> * <bento-modal-page * pageId='page1' * actions-label='Move to next page' * :actions="[ * { * title: 'Next page', * event: () => { * activePage.value = 'page2'; * }, * }]"> * Page 1 * <template #content> * Page 1 content * </template> * </bento-modal-page> * <bento-modal-page * pageId='page2' * :actions="[ * { * title: 'Save', * event: () => {}, * }]"> * Page 2 * <template #content> * Page 2 content * </template> * </bento-modal-page> * </bento-modal> * ` * } */ export default defineComponent({}); </script> <style lang="scss" scoped src="./modal-page.scss" /> 

package/dist/assets/components/modal/modal.internal.types.ts

@@ -0,0 +1 @@
+import { type ComputedRef, type Ref } from 'vue'; import type { BentoModalSize } from './modal.types'; export interface BentoModalConfigData { activePage: Ref<string>; height: Ref<string>; isAnimationActive: Ref<boolean>; pageCustomPadding: Ref<string>; showCloseButton: ComputedRef<boolean>; size: Ref<BentoModalSize | `${BentoModalSize}`>; }