@xy-planning-network/trees 0.6.2-rc-8 → 0.6.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xy-planning-network/trees",
-  "version": "0.6.2-rc-8",
+  "version": "0.6.3",
   "description": "",
   "license": "MIT",
   "repository": "github:xy-planning-network/trees",
@@ -33,6 +33,7 @@
     "typecheck:docs": "vue-tsc -p dev --noEmit"
   },
   "devDependencies": {
+    "@point-hub/vue-highlight": "^0.1.4",
     "@tailwindcss/forms": "^0.5.3",
     "@tailwindcss/line-clamp": "^0.4.2",
     "@tailwindcss/typography": "^0.5.7",

package/src/lib-components/forms/RadioCards.vue

@@ -114,11 +114,11 @@ const nameAttr = computed(() => {
         v-slot="{ active, checked, disabled }"
       >
         <div
+          class="relative bg-white border rounded-lg shadow-sm p-4 flex cursor-pointer focus:outline-none"
           :class="[
             checked ? 'border-transparent' : 'border-gray-300',
             active ? 'border-blue-500 ring-2 ring-blue-500' : '',
-            'relative bg-white border rounded-lg shadow-sm p-4 flex cursor-pointer focus:outline-none',
-            disabled ? 'opacity-75' : '',
+            disabled ? 'cursor-not-allowed opacity-75' : '',
           ]"
         >
           <div class="flex-1 flex pr-1">

package/src/lib-components/layout/SidebarLayout.vue

@@ -89,8 +89,8 @@ const isActive = (url: string): boolean => {
             <div class="shrink-0 flex justify-center px-4">
               <img class="w-auto h-12" :src="iconURL" alt="Logo" />
             </div>
-            <div class="mt-5 flex-1 h-0 overflow-y-auto">
-              <nav class="px-2 space-y-1">
+            <div class="mt-5 flex flex-col flex-1 h-0 overflow-y-auto">
+              <nav class="flex-1 px-2 space-y-1">
                 <a
                   v-for="item in navigation"
                   :key="item.name"
@@ -116,6 +116,11 @@ const isActive = (url: string): boolean => {
                   {{ item.name }}
                 </a>
               </nav>
+              <div v-if="$slots['sidebar-bottom']" class="mt-auto">
+                <div class="mt-6 px-2">
+                  <slot name="sidebar-bottom" />
+                </div>
+              </div>
             </div>
           </div>
         </TransitionChild>
@@ -162,6 +167,12 @@ const isActive = (url: string): boolean => {
                 {{ item.name }}
               </a>
             </nav>
+
+            <div v-if="$slots['sidebar-bottom']" class="mt-atuo">
+              <div class="mt-6 px-2">
+                <slot name="sidebar-bottom" />
+              </div>
+            </div>
           </div>
         </div>
       </div>

package/types/api/client.d.ts

@@ -43,12 +43,40 @@ export interface HttpPromise<T = any> extends Promise<T> {
 /**
  * TrailsPromise
  * The successfully resolved interface of an http client request returned by @xy-planning-network/Trails.
+ *
+ * Example Usage:
+ * interface User {
+ *     id: number
+ *     email: string
+ * }
+ *
+ * const UsersAPI = {
+ *    update(
+ *      id: number,
+ *      data: ReqPayload,
+ *      opts?: ReqOptions
+ *    ): TrailsPromise<User> {
+ *      return BaseAPI.put<TrailsResp<User>>(`/users/${id}`, data, opts)
+ *    }
+ * }
  */
 export interface TrailsPromise<T = any> extends Promise<TrailsResp<T>> {
 }
 /**
  * TrailsPromisePaged
  * The successfully resolved interface of a paged http client request returned by @xy-planning-network/Trails.
+ *
+ * Example Usage:
+ * interface User {
+ *     id: number
+ *     email: string
+ * }
+ *
+ * const UsersAPI = {
+ *    index(opts?: ReqOptions, params?: QueryParams): TrailsPromisePaged<User> {
+ *    return BaseAPI.get<TrailsRespPaged<User>>("/users", opts, params)
+ *    }
+ * }
  */
 export interface TrailsPromisePaged<T = any> extends Promise<TrailsRespPaged<T>> {
 }

package/types/composables/useBaseAPI.d.ts

@@ -50,7 +50,7 @@ export interface UseBaseAPI<T> {
      * Manually call the axios request
      * can be used multiple times
      */
-    execute: (data?: ReqPayload, opts?: ReqOptions) => HttpPromise<T>;
+    execute: (payload?: ReqPayload, opts?: ReqOptions) => HttpPromise<T>;
 }
 /**
  * useBaseAPI is a composable wrapper of BaseAPI