@webx-ui/module-media 0.2.0 → 0.4.0

package/dist/MediaField.d.ts

@@ -1,17 +1,31 @@
-import { MediaKind, MediaValue } from './types';
+import { MediaAspect, MediaKind, MediaValue } from './types';
 /**
  * A picture on a form, with the words this entity uses for it.
  *
- * `alt` and `title` live here rather than on the file because one picture is used by two
- * articles and needs two captions. What the field stores is the key and those words; the
- * address is worked out when the page is drawn, so moving the library to another disk changes
- * nothing here.
+ * Two states and nothing in between: an empty frame that opens the library, and the picture
+ * with what can be done to it. `alt` and `title` live here rather than on the file, because one
+ * picture used by two articles needs two captions — and they are localized for the same reason
+ * everything else on a form is.
+ *
+ * What the field stores is the key and those words. The address is worked out when the page is
+ * drawn, so moving the library to another disk changes nothing written before.
  */
 type __VLS_Props = {
     label?: string;
     accept?: MediaKind | null;
     /** Off for a decorative picture, where a caption is noise. */
     captions?: boolean;
+    /**
+     * Shape of the frame: one of the presets, any `width / height`, or `null` for a fixed
+     * height instead.
+     *
+     * A field that holds a cover and a field that holds an avatar are not the same shape, and
+     * the frame should say which before anything is in it.
+     */
+    aspect?: MediaAspect | null;
+    /** Height of the frame when there is no aspect — a number in pixels, or any CSS length. */
+    height?: number | string;
+    disabled?: boolean;
 };
 type __VLS_PublicProps = {
     modelValue?: MediaValue | null;
@@ -22,7 +36,10 @@ declare const _default: import('vue').DefineComponent<__VLS_PublicProps, {}, {},
     "onUpdate:modelValue"?: ((value: MediaValue | null) => any) | undefined;
 }>, {
     label: string;
-    accept: MediaKind | null;
+    disabled: boolean;
+    height: number | string;
     captions: boolean;
+    accept: MediaKind | null;
+    aspect: MediaAspect | null;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
 export default _default;

package/dist/MediaToolbar.d.ts

@@ -10,6 +10,8 @@ type __VLS_Props = {
     canUpload: boolean;
     canManage: boolean;
     selected: number;
+    /** The caller asked for one kind of file, so there is nothing to filter by. */
+    fixedType?: boolean;
     /** Narrow screens get the folders behind a button instead of beside the files. */
     compact: boolean;
 };

package/dist/api.d.ts

@@ -9,6 +9,13 @@ export interface MediaApi {
     deleteDirectory(id: number, force?: boolean): Promise<void>;
     files(query?: FileQuery): Promise<MediaPage>;
     file(id: number): Promise<MediaFile>;
+    /**
+     * The file behind a key.
+     *
+     * An entity stores the key and nothing else, so this is how a form draws the picture it
+     * saved last time. `null` when the file is gone from the library.
+     */
+    fileByPath(path: string): Promise<MediaFile | null>;
     upload(directoryId: number, files: File[], onProgress?: (percent: number) => void): Promise<MediaFile[]>;
     rename(id: number, name: string): Promise<MediaFile>;
     move(ids: number[], directoryId: number): Promise<number>;

package/dist/index.d.ts

@@ -19,4 +19,4 @@ export { default as WxMediaManager } from './MediaManager';
 export { default as WxMediaPage } from './MediaPage';
 export { default as WxMediaPicker } from './MediaPicker';
 export { default as WxMediaField } from './MediaField';
-export type { DirectoryNotEmpty, EditOperations, FileQuery, MediaDirectory, MediaFile, MediaKind, MediaPage, MediaValue, } from './types';
+export type { DirectoryNotEmpty, EditOperations, FileQuery, MediaDirectory, MediaFile, MediaAspect, MediaKind, MediaPage, MediaValue, } from './types';