Add docs.
rodzic
2fbbb61ef0
commit
1fb6db0759
|
@ -43,13 +43,23 @@ export interface GalleryContext {
|
||||||
*/
|
*/
|
||||||
compositions: GalleryComposition[];
|
compositions: GalleryComposition[];
|
||||||
|
|
||||||
|
/** The status of the most recent submission to the gallery. */
|
||||||
submitStatus: GallerySubmitStatus;
|
submitStatus: GallerySubmitStatus;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Submit a composition to the gallery. On success, calls the
|
||||||
|
* given callback, passing it the newly-assigned id of the
|
||||||
|
* composition.
|
||||||
|
*
|
||||||
|
* If already in the process of submitting a composition, this
|
||||||
|
* will do nothing.
|
||||||
|
*/
|
||||||
submit(
|
submit(
|
||||||
composition: Omit<GalleryComposition, "id" | "createdAt">,
|
composition: Omit<GalleryComposition, "id" | "createdAt">,
|
||||||
onSuccess: (id: string) => void
|
onSuccess: (id: string) => void
|
||||||
): void;
|
): void;
|
||||||
|
|
||||||
|
/** The most recent submission made via `submit()`, if any. */
|
||||||
lastSubmission?: GalleryComposition;
|
lastSubmission?: GalleryComposition;
|
||||||
|
|
||||||
/** Whether we're currently loading the gallery from the network. */
|
/** Whether we're currently loading the gallery from the network. */
|
||||||
|
|
Ładowanie…
Reference in New Issue