Allow injecting widgets into all object views

added part::backend part::frontend workflow::discussing labels

removed milestone

closed

reopened

assigned to @nik

added part::backend part::frontend labels

marked this issue as related to #73 (closed)

We should create an ExtensibleView that provides an API for other apps to inject templates and contexts, which are then handled by the view, e.g. by rendering the template snippets in tabs/eidgets/etc.

mentioned in merge request Teckids/ticdesk!55

added prio::1 source::customer labels

mentioned in issue #539 (closed)

mentioned in issue #610

marked this issue as related to #610

marked this issue as related to AlekSIS-App-Chronos#153

mentioned in issue AlekSIS-App-Chronos#153

This requires a major re-design. Therefore, removing from %"2022.6 — "Cohn""

removed source::customer label

Maybe discuss this issue soon, as we are currently in a major re-design phase.

we want this

mentioned in issue AlekSIS-App-Alsijil#253 (closed)

mentioned in issue AlekSIS-App-Alsijil#266 (closed)

How would this work technically: Each app can declare inside the index.js which collection the respective app defines, and which components it provides for specific collections. Vite/the bundler will somehow merge thes values and provide at a singular place (via the aleksis mixin maybe?).

Example: the core would define the collections "core-dashboard", "core-person-overview" and "core-group-overview", and alsijil would supply components for personal statistics (and at a later point one for group statistics as well)

This should work for any object type, so there could be a collection for components, but also for objects (e.g. extensible menus) or functions (e.g. extensible actions on a crud page)

added 1 deleted label

assigned to @ZugBahnHof and unassigned @nik

<script>
// Inside the index.js in the core
export const collections = [
    {
        name: "dashboard", // Auto-prefixed with the app label (?)
        type: Object, // Documentation purposes, maybe used for validation at a later point. Maybe add a validator func?
    }
]

// Inside the index.js in dashboard-feeds

export const collectionItems = {
    coreDashboard: [
        {
            name: "dashboardFeeds.rssFeedWidget",
            component: () => import("RSSFeedWidget.vue")
            shouldDisplay: (user, person, preferences) => {
                if (preferences.showDefaultDashboard) return true;
                if (user.isAdmin) return true;
                return false;
            }
        }
    ]
}

// Inside the frontend component file

import { coreDashboard } from "aleksis.collections"; // → how should the imports look?

export default {
  name: "DashboardComponent",
  mixins: { mixinThatGivesMeUserDetails },
  computed: {
    widgets() {
      // Is this really just an array or should be something different?
      return coreDashboard.filter(widget => widget.shouldDisplay(user, person, preferences));
    },
    widgetProps() {
      return {
        idk: "???",
        person,
        "???": "idk",
      }
    }
  },
};

</script>

<template>
    <div v-for="widget in widgets">
      <component :is="widget.component" v-bind="widgetProps" />
    </div>
</template>

How does this example usage look for you @hansegucker (this is purely fictional at this point)

I highlighted important things in the code for you.

I believe we also discussed something about other exported properties being merged, however then i wouldn't know how one would access them. Do you remember more?

created branch 122-allow-injecting-widgets-into-all-object-views to address this issue

mentioned in merge request !1460 (merged)

mentioned in issue #1014 (closed)

mentioned in issue #1024 (closed)

mentioned in issue AlekSIS#81 (moved)

mentioned in issue AlekSIS/onboarding/AlekSIS-App-Maka#1 (closed)

closed with merge request !1460 (merged)

mentioned in commit 6fa76124

Allow injecting widgets into all object views

Designs

Child items ...

Activity