synapse-react-client
Version:
[](https://travis-ci.com/Sage-Bionetworks/Synapse-React-Client) [](https://badge.fury.io/js/synaps
22 lines (21 loc) • 912 B
TypeScript
/// <reference types="react" />
export declare type SchemaDrivenAnnotationEditorProps = {
/** The entity whose annotations should be edited with the form */
entityId?: string;
/** If no entity ID is supplied, the schema to use for the form */
schemaId?: string;
liveValidate?: boolean;
onSuccess?: () => void;
/** If defined, shows a 'Cancel' button and runs this effect on click */
onCancel?: () => void;
};
export declare type SchemaDrivenAnnotationEditorModalProps = {
entityId: string;
show: boolean;
onHide: () => void;
};
/**
* Renders a form for editing an entity's annotations. The component also supports supplying just a schema ID,
* but work to support annotation flows without an entity (i.e. before creating entities) is not yet complete.
*/
export declare const SchemaDrivenAnnotationEditor: (props: SchemaDrivenAnnotationEditorProps) => JSX.Element;