@aerogel/core 0.0.0-next.8e6b2bcc764fa682decbb41aa6848c77a744dec3 → 0.0.0-next.906ec80f260b7e5cb54a0c97bd4905bdaf4bf916

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@aerogel/core",
     "description": "The Lightest Solid",
-    "version": "0.0.0-next.8e6b2bcc764fa682decbb41aa6848c77a744dec3",
+    "version": "0.0.0-next.906ec80f260b7e5cb54a0c97bd4905bdaf4bf916",
     "main": "dist/aerogel-core.cjs.js",
     "module": "dist/aerogel-core.esm.js",
     "types": "dist/aerogel-core.d.ts",
@@ -35,7 +35,7 @@
     },
     "dependencies": {
         "@headlessui/vue": "^1.7.14",
-        "@noeldemartin/utils": "0.5.1-next.49cc6c9b4a20930cbf922a949135981791acc5c3",
+        "@noeldemartin/utils": "0.6.0-next.036a147180df61c600c4599df30816ac860dbf06",
         "dompurify": "^3.0.3",
         "marked": "^5.0.4",
         "pinia": "^2.1.6",
@@ -43,7 +43,7 @@
     },
     "devDependencies": {
         "@aerogel/vite": "*",
-        "@histoire/plugin-vue": "^0.17.6",
+        "@histoire/plugin-vue": "0.17.6",
         "@types/dompurify": "^3.0.2",
         "@types/marked": "^5.0.0",
         "tailwindcss": "^3.3.5"

package/src/bootstrap/bootstrap.test.ts

@@ -11,7 +11,6 @@ import { bootstrap } from './index';
 describe('Aerogel', () => {
 
     beforeEach(() => {
-        vi.stubGlobal('document', { getElementById: () => null });
         vi.mock('vue', async () => {
             const vue = (await vi.importActual('vue')) as Object;
 

package/src/bootstrap/index.ts

@@ -1,6 +1,9 @@
+import Aerogel from 'virtual:aerogel';
+
 import { createApp } from 'vue';
-import type { App, Component } from 'vue';
+import type { App as AppInstance, Component } from 'vue';
 
+import App from '@/services/App';
 import directives from '@/directives';
 import errors from '@/errors';
 import Events from '@/services/Events';
@@ -13,9 +16,11 @@ import type { AerogelOptions } from '@/bootstrap/options';
 
 export { AerogelOptions };
 
-export async function bootstrapApplication(app: App, options: AerogelOptions = {}): Promise<void> {
+export async function bootstrapApplication(app: AppInstance, options: AerogelOptions = {}): Promise<void> {
     const plugins = [testing, directives, errors, lang, services, ui, ...(options.plugins ?? [])];
 
+    App.instance = app;
+
     await installPlugins(plugins, app, options);
     await options.install?.(app);
     await Events.emit('application-ready');
@@ -24,6 +29,11 @@ export async function bootstrapApplication(app: App, options: AerogelOptions = {
 export async function bootstrap(rootComponent: Component, options: AerogelOptions = {}): Promise<void> {
     const app = createApp(rootComponent);
 
+    if (Aerogel.environment === 'development') {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        (window as any).$aerogel = app;
+    }
+
     await bootstrapApplication(app, options);
 
     app.mount('#app');

package/src/components/AGAppSnackbars.vue

@@ -1,5 +1,5 @@
 <template>
-    <div aria-live="assertive" class="z-60 pointer-events-none fixed inset-0 flex items-end px-4 py-6 sm:p-6">
+    <div aria-live="assertive" class="pointer-events-none fixed inset-0 z-50 flex items-end px-4 py-6 sm:p-6">
         <div class="flex w-full flex-col items-end space-y-4">
             <component
                 :is="snackbar.component"

package/src/components/composition.ts

@@ -0,0 +1,23 @@
+import { customRef } from 'vue';
+import type { Ref } from 'vue';
+
+import { getElement } from '@/components/interfaces';
+
+export function elementRef(): Ref<HTMLElement | undefined> {
+    return customRef((track, trigger) => {
+        let value: HTMLElement | undefined = undefined;
+
+        return {
+            get() {
+                track();
+
+                return value;
+            },
+            set(newValue) {
+                value = getElement(newValue);
+
+                trigger();
+            },
+        };
+    });
+}

package/src/components/forms/AGForm.vue

@@ -1,26 +1,25 @@
 <template>
-    <form @submit.prevent="submit">
+    <form @submit.prevent="form?.submit()">
         <slot />
     </form>
 </template>
 
 <script setup lang="ts">
-import { provide } from 'vue';
+import { provide, watchEffect } from 'vue';
 
 import { objectProp } from '@/utils/vue';
 import type Form from '@/forms/Form';
 
+let offSubmit: (() => void) | undefined;
 const props = defineProps({ form: objectProp<Form>() });
-
 const emit = defineEmits<{ submit: [] }>();
 
-provide('form', props.form);
+watchEffect((onCleanup) => {
+    offSubmit?.();
+    offSubmit = props.form?.on('submit', () => emit('submit'));
 
-function submit() {
-    if (props.form && !props.form.submit()) {
-        return;
-    }
+    onCleanup(() => offSubmit?.());
+});
 
-    emit('submit');
-}
+provide('form', props.form);
 </script>

package/src/components/forms/AGInput.vue

@@ -13,6 +13,7 @@
                 'ring-1 ring-red-500': $input?.errors,
             }"
         />
+        <AGHeadlessInputDescription />
         <div class="absolute bottom-0 left-0 translate-y-full">
             <AGHeadlessInputError class="mt-1 text-sm text-red-500" />
         </div>
@@ -26,6 +27,7 @@ import { useInputProps } from '@/components/headless/forms/AGHeadlessInput';
 import type { IAGHeadlessInput } from '@/components/headless/forms/AGHeadlessInput';
 
 import AGHeadlessInput from '../headless/forms/AGHeadlessInput.vue';
+import AGHeadlessInputDescription from '../headless/forms/AGHeadlessInputDescription.vue';
 import AGHeadlessInputError from '../headless/forms/AGHeadlessInputError.vue';
 import AGHeadlessInputInput from '../headless/forms/AGHeadlessInputInput.vue';
 import AGHeadlessInputLabel from '../headless/forms/AGHeadlessInputLabel.vue';

package/src/components/headless/forms/AGHeadlessButton.ts

@@ -0,0 +1,3 @@
+import type { HasElement } from '@/components/interfaces';
+
+export interface IAGHeadlessButton extends HasElement {}

package/src/components/headless/forms/AGHeadlessButton.vue

@@ -1,5 +1,5 @@
 <template>
-    <component :is="component.tag" v-bind="component.props">
+    <component :is="component.as" ref="$root" v-bind="component.props">
         <slot />
     </component>
 </template>
@@ -9,8 +9,12 @@ import { computed } from 'vue';
 import { objectWithoutEmpty } from '@noeldemartin/utils';
 
 import { booleanProp, objectProp, stringProp } from '@/utils/vue';
+import { elementRef } from '@/components/composition';
+
+import type { IAGHeadlessButton } from './AGHeadlessButton';
 
 const props = defineProps({
+    as: objectProp(),
     href: stringProp(),
     url: stringProp(),
     route: stringProp(),
@@ -19,10 +23,15 @@ const props = defineProps({
     submit: booleanProp(),
 });
 
+const $root = elementRef();
 const component = computed(() => {
+    if (props.as) {
+        return { as: props.as, props: {} };
+    }
+
     if (props.route) {
         return {
-            tag: 'router-link',
+            as: 'router-link',
             props: {
                 to: objectWithoutEmpty({
                     name: props.route,
@@ -35,7 +44,7 @@ const component = computed(() => {
 
     if (props.href || props.url) {
         return {
-            tag: 'a',
+            as: 'a',
             props: {
                 target: '_blank',
                 href: props.href || props.url,
@@ -44,8 +53,10 @@ const component = computed(() => {
     }
 
     return {
-        tag: 'button',
+        as: 'button',
         props: { type: props.submit ? 'submit' : 'button' },
     };
 });
+
+defineExpose<IAGHeadlessButton>({ $el: $root });
 </script>

package/src/components/headless/forms/AGHeadlessInput.ts

@@ -1,20 +1,26 @@
 import type { ComputedRef, DeepReadonly, ExtractPropTypes, Ref } from 'vue';
 
-import { stringProp } from '@/utils';
+import { mixedProp, stringProp } from '@/utils';
 import { extractComponentProps } from '@/components/utils';
+import type { FormFieldValue } from '@/forms/Form';
+import type { HasElement } from '@/components/interfaces';
 
-export interface IAGHeadlessInput {
+export interface IAGHeadlessInput extends HasElement {
     id: string;
     name: ComputedRef<string | null>;
     label: ComputedRef<string | null>;
-    value: ComputedRef<string | number | boolean | null>;
+    description: ComputedRef<string | boolean | null>;
+    value: ComputedRef<FormFieldValue | null>;
+    required: ComputedRef<boolean | null>;
     errors: DeepReadonly<Ref<string[] | null>>;
-    update(value: string | number | boolean | null): void;
+    update(value: FormFieldValue | null): void;
 }
 
 export const inputProps = {
     name: stringProp(),
     label: stringProp(),
+    description: stringProp(),
+    modelValue: mixedProp<FormFieldValue>([String, Number, Boolean]),
 };
 
 export function useInputProps(): typeof inputProps {

package/src/components/headless/forms/AGHeadlessInput.vue

@@ -6,11 +6,12 @@
 </template>
 
 <script setup lang="ts">
-import { computed, inject, provide, readonly } from 'vue';
+import { computed, inject, provide, readonly, ref } from 'vue';
 import { uuid } from '@noeldemartin/utils';
 
-import { mixedProp, stringProp } from '@/utils/vue';
+import { stringProp } from '@/utils/vue';
 import type Form from '@/forms/Form';
+import type { __SetsElement } from '@/components/interfaces';
 
 import { useInputProps } from './AGHeadlessInput';
 import type { IAGHeadlessInput } from './AGHeadlessInput';
@@ -18,9 +19,9 @@ import type { IAGHeadlessInput } from './AGHeadlessInput';
 const emit = defineEmits(['update:modelValue']);
 const props = defineProps({
     as: stringProp('div'),
-    modelValue: mixedProp<string | number | boolean>([String, Number, Boolean]),
     ...useInputProps(),
 });
+const $el = ref<HTMLElement>();
 const errors = computed(() => {
     if (!form || !props.name) {
         return null;
@@ -29,18 +30,27 @@ const errors = computed(() => {
     return form.errors[props.name] ?? null;
 });
 const form = inject<Form | null>('form', null);
-const api: IAGHeadlessInput = {
+const api: IAGHeadlessInput & __SetsElement = {
+    $el,
     id: `input-${uuid()}`,
     name: computed(() => props.name),
     label: computed(() => props.label),
+    description: computed(() => props.description),
     value: computed(() => {
         if (form && props.name) {
-            return form.getFieldValue(props.name) as string | number | boolean | null;
+            return form.getFieldValue(props.name);
         }
 
         return props.modelValue;
     }),
     errors: readonly(errors),
+    required: computed(() => {
+        if (!props.name || !form) {
+            return null;
+        }
+
+        return form.getFieldRules(props.name).includes('required');
+    }),
     update(value) {
         if (form && props.name) {
             form.setFieldValue(props.name, value);
@@ -50,6 +60,9 @@ const api: IAGHeadlessInput = {
 
         emit('update:modelValue', value);
     },
+    __setElement(element) {
+        $el.value = element;
+    },
 };
 
 provide<IAGHeadlessInput>('input', api);

package/src/components/headless/forms/AGHeadlessInputDescription.vue

@@ -0,0 +1,28 @@
+<template>
+    <slot :id="`${input.id}-description`">
+        <AGMarkdown
+            v-if="show"
+            v-bind="$attrs"
+            :id="`${input.id}-description`"
+            :text="text"
+        />
+    </slot>
+</template>
+
+<script setup lang="ts">
+import { computed } from 'vue';
+
+import { injectReactiveOrFail } from '@/utils/vue';
+
+import AGMarkdown from '../../lib/AGMarkdown.vue';
+import type { IAGHeadlessInput } from './AGHeadlessInput';
+
+defineOptions({ inheritAttrs: false });
+
+const input = injectReactiveOrFail<IAGHeadlessInput>(
+    'input',
+    '<AGHeadlessInputDescription> must be a child of a <AGHeadlessInput>',
+);
+const text = computed(() => (typeof input.description === 'string' ? input.description : ''));
+const show = computed(() => !!input.description);
+</script>

package/src/components/headless/forms/AGHeadlessInputInput.vue

@@ -4,20 +4,26 @@
         ref="$input"
         :name="name"
         :type="type"
-        :value="value"
+        :required="input.required ?? undefined"
         :aria-invalid="input.errors ? 'true' : 'false'"
-        :aria-describedby="input.errors ? `${input.id}-error` : undefined"
+        :aria-describedby="
+            input.errors ? `${input.id}-error` : input.description ? `${input.id}-description` : undefined
+        "
         :checked="checked"
         @input="update"
     >
 </template>
 
 <script setup lang="ts">
-import { computed, ref } from 'vue';
+import { computed, ref, watchEffect } from 'vue';
 
-import { injectReactiveOrFail, stringProp } from '@/utils';
+import { injectReactiveOrFail, stringProp } from '@/utils/vue';
+import type { __SetsElement } from '@/components/interfaces';
+import type { FormFieldValue } from '@/forms/Form';
 import type { IAGHeadlessInput } from '@/components/headless/forms/AGHeadlessInput';
 
+import { onFormFocus } from './composition';
+
 const props = defineProps({
     type: stringProp('text'),
 });
@@ -42,6 +48,37 @@ function update() {
         return;
     }
 
-    input.update(props.type === 'checkbox' ? $input.value.checked : $input.value.value);
+    input.update(getValue());
 }
+
+function getValue(): FormFieldValue | null {
+    if (!$input.value) {
+        return null;
+    }
+
+    switch (props.type) {
+        case 'checkbox':
+            return $input.value.checked;
+        case 'date':
+            return $input.value.valueAsDate;
+        default:
+            return $input.value.value;
+    }
+}
+
+onFormFocus(input, () => $input.value?.focus());
+watchEffect(() => (input as unknown as __SetsElement).__setElement($input.value));
+watchEffect(() => {
+    if (!$input.value) {
+        return;
+    }
+
+    if (props.type === 'date') {
+        $input.value.valueAsDate = value.value as Date;
+
+        return;
+    }
+
+    $input.value.value = value.value as string;
+});
 </script>

package/src/components/headless/forms/AGHeadlessInputTextArea.vue

@@ -0,0 +1,43 @@
+<template>
+    <textarea
+        :id="input.id"
+        ref="$textArea"
+        :name="name"
+        :required="input.required ?? undefined"
+        :value="value"
+        :aria-invalid="input.errors ? 'true' : 'false'"
+        :aria-describedby="
+            input.errors ? `${input.id}-error` : input.description ? `${input.id}-description` : undefined
+        "
+        @input="update"
+    />
+</template>
+
+<script setup lang="ts">
+import { computed, ref, watchEffect } from 'vue';
+
+import { injectReactiveOrFail } from '@/utils/vue';
+import type { IAGHeadlessInput } from '@/components/headless/forms/AGHeadlessInput';
+import type { __SetsElement } from '@/components/interfaces';
+
+import { onFormFocus } from './composition';
+
+const $textArea = ref<HTMLTextAreaElement>();
+const input = injectReactiveOrFail<IAGHeadlessInput>(
+    'input',
+    '<AGHeadlessInputTextArea> must be a child of a <AGHeadlessInput>',
+);
+const name = computed(() => input.name ?? undefined);
+const value = computed(() => input.value as string);
+
+function update() {
+    if (!$textArea.value) {
+        return;
+    }
+
+    input.update($textArea.value.value);
+}
+
+watchEffect(() => (input as unknown as __SetsElement).__setElement($textArea.value));
+onFormFocus(input, () => $textArea.value?.focus());
+</script>

package/src/components/headless/forms/composition.ts

@@ -0,0 +1,10 @@
+import { inject, onUnmounted } from 'vue';
+
+import type Form from '@/forms/Form';
+
+export function onFormFocus(input: { name: string | null }, listener: () => unknown): void {
+    const form = inject<Form | null>('form', null);
+    const stop = form?.on('focus', (name) => input.name === name && listener());
+
+    onUnmounted(() => stop?.());
+}

package/src/components/headless/forms/index.ts

@@ -1,11 +1,15 @@
+export * from './composition';
+export * from './AGHeadlessButton';
 export * from './AGHeadlessInput';
 export * from './AGHeadlessSelect';
 export * from './AGHeadlessSelectOption';
 export { default as AGHeadlessButton } from './AGHeadlessButton.vue';
 export { default as AGHeadlessInput } from './AGHeadlessInput.vue';
+export { default as AGHeadlessInputDescription } from './AGHeadlessInputDescription.vue';
 export { default as AGHeadlessInputError } from './AGHeadlessInputError.vue';
 export { default as AGHeadlessInputInput } from './AGHeadlessInputInput.vue';
 export { default as AGHeadlessInputLabel } from './AGHeadlessInputLabel.vue';
+export { default as AGHeadlessInputTextArea } from './AGHeadlessInputTextArea.vue';
 export { default as AGHeadlessSelect } from './AGHeadlessSelect.vue';
 export { default as AGHeadlessSelectButton } from './AGHeadlessSelectButton.vue';
 export { default as AGHeadlessSelectError } from './AGHeadlessSelectError.vue';

package/src/components/headless/modals/AGHeadlessModal.ts

@@ -13,6 +13,7 @@ export interface IAGHeadlessModalDefaultSlotProps {
 
 export const modalProps = {
     cancellable: booleanProp(true),
+    inline: booleanProp(),
     title: stringProp(),
 };
 
@@ -28,7 +29,8 @@ export function extractModalProps<T extends ExtractPropTypes<typeof modalProps>>
 
 export function useModalExpose($modal: Ref<IAGHeadlessModal | undefined>): IAGModal {
     return {
-        close: async () => $modal.value?.close(),
+        inline: computed(() => !!$modal.value?.inline),
         cancellable: computed(() => !!$modal.value?.cancellable),
+        close: async () => $modal.value?.close(),
     };
 }

package/src/components/headless/modals/AGHeadlessModal.vue

@@ -1,11 +1,16 @@
 <template>
-    <Dialog ref="$root" :open="true" @close="cancellable && close()">
+    <component
+        :is="rootComponent"
+        ref="$root"
+        :open="true"
+        @close="cancellable && close()"
+    >
         <slot :close="close" />
-    </Dialog>
+    </component>
 </template>
 
 <script setup lang="ts">
-import { ref, toRef } from 'vue';
+import { computed, ref, toRef } from 'vue';
 import { Dialog } from '@headlessui/vue';
 import type { VNode } from 'vue';
 
@@ -26,6 +31,7 @@ const { modal } = injectReactiveOrFail<IAGModalContext>(
     'could not obtain modal reference from <AGHeadlessModal>, ' +
         'did you render this component manually? Show it using $ui.openModal() instead',
 );
+const rootComponent = computed(() => (modal.properties.inline ? 'div' : Dialog));
 
 async function hide(): Promise<void> {
     if (!$root.value?.$el) {
@@ -82,5 +88,5 @@ useEvent('show-modal', async ({ id }) => {
 });
 
 defineSlots<{ default(props: IAGHeadlessModalDefaultSlotProps): VNode[] }>();
-defineExpose<IAGHeadlessModal>({ close, cancellable: toRef(props, 'cancellable') });
+defineExpose<IAGHeadlessModal>({ close, cancellable: toRef(props, 'cancellable'), inline: toRef(props, 'inline') });
 </script>

package/src/components/headless/modals/AGHeadlessModalPanel.vue

@@ -1,12 +1,15 @@
 <template>
-    <DialogPanel>
+    <component :is="rootComponent">
         <slot />
 
         <template v-if="childModal">
-            <div class="pointer-events-none fixed inset-0 z-50 bg-black/30" />
-            <AGModalContext :child-index="modal.childIndex + 1" :modal="childModal" />
+            <div
+                class="pointer-events-none inset-0 z-50 bg-black/30"
+                :class="childModal.properties.inline ? 'absolute' : 'fixed'"
+            />
+            <AGModalContext :child-index="childIndex + 1" :modal="childModal" />
         </template>
-    </DialogPanel>
+    </component>
 </template>
 
 <script setup lang="ts">
@@ -19,10 +22,11 @@ import type { IAGModalContext } from '@/components/modals/AGModalContext';
 
 import AGModalContext from '../../modals/AGModalContext.vue';
 
-const modal = injectReactiveOrFail<IAGModalContext>(
+const { modal, childIndex } = injectReactiveOrFail<IAGModalContext>(
     'modal',
     'could not obtain modal reference from <AGHeadlessModalPanel>, ' +
         'did you render this component manually? Show it using $ui.openModal() instead',
 );
-const childModal = computed(() => UI.modals[modal.childIndex] ?? null);
+const rootComponent = computed(() => (modal.properties.inline ? 'div' : DialogPanel));
+const childModal = computed(() => UI.modals[childIndex] ?? null);
 </script>

package/src/components/headless/modals/AGHeadlessModalTitle.vue

@@ -1,13 +1,23 @@
 <template>
-    <DialogTitle :as="as">
+    <component :is="rootComponent" v-bind="rootProps">
         <slot />
-    </DialogTitle>
+    </component>
 </template>
 
 <script setup lang="ts">
+import { computed } from 'vue';
 import { DialogTitle } from '@headlessui/vue';
 
-import { stringProp } from '@/utils/vue';
+import { injectReactiveOrFail, stringProp } from '@/utils/vue';
+import type { IAGModalContext } from '@/components/modals/AGModalContext';
 
-defineProps({ as: stringProp('h2') });
+const props = defineProps({ as: stringProp('h2') });
+
+const { modal } = injectReactiveOrFail<IAGModalContext>(
+    'modal',
+    'could not obtain modal reference from <AGHeadlessModalPanel>, ' +
+        'did you render this component manually? Show it using $ui.openModal() instead',
+);
+const rootComponent = computed(() => (modal.properties.inline ? 'div' : DialogTitle));
+const rootProps = computed(() => (modal.properties.inline ? {} : { as: props.as }));
 </script>

package/src/components/index.ts

@@ -3,9 +3,11 @@ import AGAppOverlays from './AGAppOverlays.vue';
 
 export { AGAppLayout, AGAppOverlays };
 
+export * from './composition';
 export * from './constants';
 export * from './forms';
 export * from './headless';
+export * from './interfaces';
 export * from './lib';
 export * from './modals';
 export * from './snackbars';

package/src/components/interfaces.ts

@@ -0,0 +1,24 @@
+import { isObject } from '@noeldemartin/utils';
+import type { Ref, UnwrapNestedRefs } from 'vue';
+
+export function getElement(value: unknown): HTMLElement | undefined {
+    if (value instanceof HTMLElement) {
+        return value;
+    }
+
+    if (hasElement(value)) {
+        return value.$el;
+    }
+}
+
+export function hasElement(value: unknown): value is UnwrapNestedRefs<HasElement> {
+    return isObject(value) && '$el' in value;
+}
+
+export interface __SetsElement {
+    __setElement(element?: HTMLElement): void;
+}
+
+export interface HasElement {
+    $el: Readonly<Ref<HTMLElement | undefined>>;
+}