synapse-react-client
Version:
[](https://travis-ci.com/Sage-Bionetworks/Synapse-React-Client) [](https://badge.fury.io/js/synaps
31 lines (30 loc) • 1.76 kB
TypeScript
/// <reference types="react" />
export declare const ENTITY_BADGE_ICONS_TOOLTIP_ID = "EntityBadgeIconsTooltipID";
export declare type EntityBadgeIconsProps = {
entityId: string;
versionNumber?: number;
flexWrap?: 'wrap' | 'nowrap' | '-moz-initial' | 'inherit' | 'initial' | 'revert' | 'unset' | 'wrap-reverse';
justifyContent?: 'flex-start' | 'flex-end' | string;
/** Shows an icon indicating if the entity is 'public' or 'private'. Default true */
showIsPublicPrivate?: boolean;
/** Shows an icon if the entity has sharing settings set on itself. Default true */
showHasLocalSharingSettings?: boolean;
/** Shows an icon if the entity has annotations, or if it has a validation schema (in experimental mode only). Default true */
showHasAnnotations?: boolean;
/** Shows an icon if the entity a wiki. Default true */
showHasWiki?: boolean;
/** Shows an icon if the entity has been mentioned in discussion threads. Default true */
showHasDiscussionThread?: boolean;
showUnlink?: boolean;
onUnlink?: (entityId: string) => void;
onUnlinkError?: (error: Error) => void;
/** Whether or not the badges (e.g. Annotations) can trigger opening a modal on click */
canOpenModal: boolean;
/** Whether this component should render a ReactTooltip or if an external component is managing it */
renderTooltipComponent: boolean;
};
/**
* Stateless component used to show icons that show an entity's status.
* Adapted from https://github.com/Sage-Bionetworks/SynapseWebClient/blob/46b9b717636cda2421926d96365244bbb72a05b6/src/main/java/org/sagebionetworks/web/client/widget/entity/EntityBadge.java
*/
export declare const EntityBadgeIcons: (props: EntityBadgeIconsProps) => JSX.Element;