Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(*): add support to EntityBaseTable to use action button outside [KHCP-9618] #913

Merged
merged 16 commits into from
Nov 29, 2023
Merged

feat(*): add support to EntityBaseTable to use action button outside [KHCP-9618] #913

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
ea2f870
feat(*): add support to EntityBaseTable to use action button outside
mptap Nov 14, 2023
1572114
fix(*): apply pr feedback and add props to a poc entity
mptap Nov 14, 2023
ed974dd
fix(*): fix conditional logic
mptap Nov 14, 2023
cbb0b74
fix(*): apply pr feedback
mptap Nov 14, 2023
3049697
fix(*): apply pr feedback
mptap Nov 15, 2023
66c320f
fix(*): use static id for consuming app
mptap Nov 15, 2023
4720395
fix(*): use Teleport in routes and plugins
mptap Nov 15, 2023
255bd89
feat(*): add useActionOutside prop and Teleport to all entities
mptap Nov 15, 2023
717f7f0
feat(*): add useActionOutside prop and Teleport to ConsumerCredential
mptap Nov 15, 2023
8daeaa8
feat(*): add tooltip to each entity create new button
mptap Nov 16, 2023
4f8b11e
fix(*): fix indentation
mptap Nov 16, 2023
c6caef4
fix(*): remove tooltip from create new entities button
mptap Nov 16, 2023
43d38ff
fix(*): hide teleported create button in empty state for all entities
mptap Nov 17, 2023
dac16f1
fix(*): avoid jump of cta button for all entities
mptap Nov 20, 2023
a13fd9d
fix(*): show teleported create button by default for all entities
mptap Nov 28, 2023
e64784a
fix(*): use data length instead as fetcherState doesnt update
mptap Nov 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 30 additions & 10 deletions packages/entities/entities-certificates/src/components/CACertificateList.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
preferences-storage-key="kong-ui-entities-ca-certificates-list"
:query="filterQuery"
:table-headers="tableHeaders"
:use-action-outside="useActionOutside"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mptap Should this line be removed? Because EntityBaseTable does not have the use-action-outside prop.

@clear-search-input="clearFilter"
@click:row="(row: any) => rowClick(row as EntityRow)"
@sort="resetPagination"
Expand All @@ -26,16 +27,23 @@
</template>
<!-- Create action -->
<template #toolbar-button>
<PermissionsWrapper :auth-function="() => canCreate()">
<KButton
appearance="primary"
data-testid="toolbar-add-ca-certificate"
icon="plus"
:to="config.createRoute"
>
{{ t('ca-certificates.list.toolbar_actions.new_ca_certificate') }}
</KButton>
</PermissionsWrapper>
<!-- Hide Create button if table is empty -->
<Teleport
:disabled="!useActionOutside"
to="#kong-ui-app-page-header-action-button"
>
<PermissionsWrapper :auth-function="() => canCreate()">
<KButton
v-show="hasData"
appearance="primary"
data-testid="toolbar-add-ca-certificate"
icon="plus"
:to="config.createRoute"
>
{{ t('ca-certificates.list.toolbar_actions.new_ca_certificate') }}
</KButton>
</PermissionsWrapper>
</Teleport>
</template>

<!-- Column Formatting -->
Expand Down Expand Up @@ -215,6 +223,11 @@ const props = defineProps({
required: false,
default: async () => true,
},
/** default to false, setting to true will teleport the toolbar button to the destination in the consuming app */
useActionOutside: {
type: Boolean,
default: false,
},
})

const { i18n: { t, formatUnixTimeStamp }, i18nT } = composables.useI18n()
Expand Down Expand Up @@ -415,10 +428,17 @@ const confirmDelete = async (): Promise<void> => {
}
}

const hasData = ref(true)

/**
* Watchers
*/
watch(fetcherState, (state) => {
// if table is empty, hide the teleported Create button
if (state?.response?.data?.length === 0) {
hasData.value = false
}

if (state.status === FetcherStatus.Error) {
errorMessage.value = {
title: t('ca-certificates.errors.general'),
Expand Down
40 changes: 30 additions & 10 deletions packages/entities/entities-certificates/src/components/CertificateList.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
preferences-storage-key="kong-ui-entities-certificates-list"
:query="filterQuery"
:table-headers="tableHeaders"
:use-action-outside="useActionOutside"
@clear-search-input="clearFilter"
@click:row="(row: any) => rowClick(row as EntityRow)"
@sort="resetPagination"
Expand All @@ -26,16 +27,23 @@
</template>
<!-- Create action -->
<template #toolbar-button>
<PermissionsWrapper :auth-function="() => canCreate()">
<KButton
appearance="primary"
data-testid="toolbar-add-certificate"
icon="plus"
:to="config.createRoute"
>
{{ t('certificates.list.toolbar_actions.new_certificate') }}
</KButton>
</PermissionsWrapper>
<!-- Hide Create button if table is empty -->
<Teleport
:disabled="!useActionOutside"
to="#kong-ui-app-page-header-action-button"
>
<PermissionsWrapper :auth-function="() => canCreate()">
<KButton
v-show="hasData"
appearance="primary"
data-testid="toolbar-add-certificate"
icon="plus"
:to="config.createRoute"
>
{{ t('certificates.list.toolbar_actions.new_certificate') }}
</KButton>
</PermissionsWrapper>
</Teleport>
</template>

<!-- Column Formatting -->
Expand Down Expand Up @@ -249,6 +257,11 @@ const props = defineProps({
required: false,
default: async () => true,
},
/** default to false, setting to true will teleport the toolbar button to the destination in the consuming app */
useActionOutside: {
type: Boolean,
default: false,
},
})

const { i18n: { t, formatUnixTimeStamp }, i18nT } = composables.useI18n()
Expand Down Expand Up @@ -482,10 +495,17 @@ const confirmDelete = async (): Promise<void> => {
}
}

const hasData = ref(true)

/**
* Watchers
*/
watch(fetcherState, (state) => {
// if table is empty, hide the teleported Create button
if (state?.response?.data?.length === 0) {
hasData.value = false
}

if (state.status === FetcherStatus.Error) {
errorMessage.value = {
title: t('certificates.errors.general'),
Expand Down
41 changes: 31 additions & 10 deletions packages/entities/entities-consumer-credentials/src/components/ConsumerCredentialList.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,28 @@
pagination-type="offset"
preferences-storage-key="kong-ui-entities-consumer-credentials-list"
:table-headers="tableHeaders"
:use-action-outside="useActionOutside"
@sort="resetPagination"
>
<!-- Create action -->
<template #toolbar-button>
<PermissionsWrapper :auth-function="() => canCreate()">
<KButton
appearance="primary"
data-testid="toolbar-add-credential"
icon="plus"
:to="config.createRoute"
>
{{ t(`credentials.list.toolbar_actions.${config.plugin}.new`) }}
</KButton>
</PermissionsWrapper>
<!-- Hide Create button if table is empty -->
<Teleport
:disabled="!useActionOutside"
to="#kong-ui-app-page-header-action-button"
>
<PermissionsWrapper :auth-function="() => canCreate()">
<KButton
v-show="hasData"
appearance="primary"
data-testid="toolbar-add-credential"
icon="plus"
:to="config.createRoute"
>
{{ t(`credentials.list.toolbar_actions.${config.plugin}.new`) }}
</KButton>
</PermissionsWrapper>
</Teleport>
</template>

<!-- Column Formatting -->
Expand Down Expand Up @@ -251,6 +259,11 @@ const props = defineProps({
required: false,
default: async () => true,
},
/** default to false, setting to true will teleport the toolbar button to the destination in the consuming app */
useActionOutside: {
type: Boolean,
default: false,
},
})

const { i18n: { t, formatUnixTimeStamp } } = composables.useI18n()
Expand Down Expand Up @@ -443,10 +456,18 @@ const confirmDelete = async (): Promise<void> => {
}
}

// Remount the table when hasData changes
const hasData = ref(true)

/**
* Watchers
*/
watch(fetcherState, (state) => {
// if table is empty, hide the teleported Create button
if (state?.response?.data?.length === 0) {
hasData.value = false
}

if (state.status === FetcherStatus.Error) {
errorMessage.value = {
title: t('credentials.error.general'),
Expand Down
42 changes: 31 additions & 11 deletions packages/entities/entities-consumer-groups/src/components/ConsumerGroupList.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
:query="filterQuery"
:row-attributes="rowAttributes"
:table-headers="tableHeaders"
:use-action-outside="useActionOutside"
@clear-search-input="clearFilter"
@click:row="(row: any) => rowClick(row as EntityRow)"
@empty-state-cta-clicked="handleEmptyStateCtaClicked"
Expand All @@ -30,17 +31,24 @@
</template>
<!-- Create action -->
<template #toolbar-button>
<PermissionsWrapper :auth-function="() => canCreate()">
<KButton
appearance="primary"
data-testid="toolbar-add-consumer-group"
icon="plus"
:to="config.consumerId ? undefined : config.createRoute"
@click="() => config.consumerId ? handleAddToGroupClick() : undefined"
>
{{ config.consumerId ? t('consumer_groups.actions.add_to_group') : t('consumer_groups.list.toolbar_actions.new_consumer_group') }}
</KButton>
</PermissionsWrapper>
<!-- Hide Create button if table is empty -->
<Teleport
:disabled="!useActionOutside"
to="#kong-ui-app-page-header-action-button"
>
<PermissionsWrapper :auth-function="() => canCreate()">
<KButton
v-show="hasData"
appearance="primary"
data-testid="toolbar-add-consumer-group"
icon="plus"
:to="config.consumerId ? undefined : config.createRoute"
@click="() => config.consumerId ? handleAddToGroupClick() : undefined"
>
{{ config.consumerId ? t('consumer_groups.actions.add_to_group') : t('consumer_groups.list.toolbar_actions.new_consumer_group') }}
</KButton>
</PermissionsWrapper>
</Teleport>
</template>

<!-- Column Formatting -->
Expand Down Expand Up @@ -252,6 +260,11 @@ const props = defineProps({
required: false,
default: async () => true,
},
/** default to false, setting to true will teleport the toolbar button to the destination in the consuming app */
useActionOutside: {
type: Boolean,
default: false,
},
})

const { i18nT, i18n: { t } } = composables.useI18n()
Expand Down Expand Up @@ -543,10 +556,17 @@ const exitGroups = async (): Promise<void> => {
}
}

const hasData = ref(true)

/**
* Watchers
*/
watch(fetcherState, (state) => {
// if table is empty, hide the teleported Create button
if (state?.response?.data?.length === 0) {
hasData.value = false
}

if (state.status === FetcherStatus.Error) {
errorMessage.value = {
title: t('consumer_groups.errors.general'),
Expand Down
42 changes: 31 additions & 11 deletions packages/entities/entities-consumers/src/components/ConsumerList.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
:query="filterQuery"
:row-attributes="rowAttributes"
:table-headers="tableHeaders"
:use-action-outside="useActionOutside"
@clear-search-input="clearFilter"
@click:row="(row: any) => rowClick(row as EntityRow)"
@empty-state-cta-clicked="handleEmptyStateCtaClicked"
Expand All @@ -30,17 +31,24 @@
</template>
<!-- Create action -->
<template #toolbar-button>
<PermissionsWrapper :auth-function="() => canCreate()">
<KButton
appearance="primary"
data-testid="toolbar-add-consumer"
icon="plus"
:to="config.consumerGroupId ? undefined : config.createRoute"
@click="() => config.consumerGroupId ? handleAddConsumerClick() : undefined"
>
{{ config.consumerGroupId ? t('consumers.actions.add_consumer') : t('consumers.list.toolbar_actions.new_consumer') }}
</KButton>
</PermissionsWrapper>
<!-- Hide Create button if table is empty -->
<Teleport
:disabled="!useActionOutside"
to="#kong-ui-app-page-header-action-button"
>
<PermissionsWrapper :auth-function="() => canCreate()">
<KButton
v-show="hasData"
appearance="primary"
data-testid="toolbar-add-consumer"
icon="plus"
:to="config.consumerGroupId ? undefined : config.createRoute"
@click="() => config.consumerGroupId ? handleAddConsumerClick() : undefined"
>
{{ config.consumerGroupId ? t('consumers.actions.add_consumer') : t('consumers.list.toolbar_actions.new_consumer') }}
</KButton>
</PermissionsWrapper>
</Teleport>
</template>

<!-- Column Formatting -->
Expand Down Expand Up @@ -252,6 +260,11 @@ const props = defineProps({
required: false,
default: async () => true,
},
/** default to false, setting to true will teleport the toolbar button to the destination in the consuming app */
useActionOutside: {
type: Boolean,
default: false,
},
})

const { i18nT, i18n: { t } } = composables.useI18n()
Expand Down Expand Up @@ -553,10 +566,17 @@ const removeConsumers = async (): Promise<void> => {
}
}

const hasData = ref(true)

/**
* Watchers
*/
watch(fetcherState, (state) => {
// if table is empty, hide the teleported Create button
if (state?.response?.data?.length === 0) {
hasData.value = false
}

if (state.status === FetcherStatus.Error) {
errorMessage.value = {
title: t('consumers.errors.general'),
Expand Down
Loading
Loading