@hansevision/tp-richtexteditor-control 1.0.0

package/dist/richTextEditor/components/filePicker/components/fields/fieldNameRenderer/FieldNameRenderer.d.ts

@@ -0,0 +1,60 @@
+import * as React from 'react';
+import { IFieldRendererProps } from '../fieldCommon/IFieldRendererProps';
+export interface IFieldNameRendererProps extends IFieldRendererProps {
+    /**
+     * text to display
+     */
+    text?: string;
+    /**
+     * if the Name should be rendered as link
+     */
+    isLink: boolean;
+    /**
+     * path to the document
+     */
+    filePath?: string;
+    /**
+     * true if the document is new
+     */
+    isNew?: boolean;
+    /**
+     * true if the document type has preview (true by default).
+     * The flag impacts on the link's href:
+     * if the flag is tru then the href is constructed like #id=${filePath}&parent=${filePath.substring(0, filePath.lastIndexOf('/'))},
+     * otherwise the href will contain filePath only.
+     */
+    hasPreview?: boolean;
+    /**
+     * custom handler for link click. If not set link click will lead to rendering document preview
+     */
+    onClick?: (args: IFieldNameClickEventArgs) => void;
+    /**
+     * custom handler for link double click. If not set link will use OOTB behavior.
+     */
+    onDoubleClick?: (args: IFieldNameClickEventArgs) => void;
+}
+/**
+ * For future
+ */
+export interface IFieldNameRendererState {
+}
+/**
+ * Name click event arguments
+ */
+export interface IFieldNameClickEventArgs {
+    filePath?: string;
+}
+/**
+ * Field Title Renderer.
+ * Used for:
+ *   - Title
+ */
+export declare class FieldNameRenderer extends React.Component<IFieldNameRendererProps, IFieldNameRendererState> {
+    private _button;
+    constructor(props: IFieldNameRendererProps, state: IFieldNameRendererState);
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    render(): JSX.Element;
+    private _onClick;
+    private _onDoubleClick;
+}

package/dist/richTextEditor/components/filePicker/components/fields/fieldNameRenderer/index.d.ts

@@ -0,0 +1,2 @@
+export * from './FieldNameRenderer.module.scss';
+export * from './FieldNameRenderer';

package/dist/richTextEditor/components/filePicker/components/fields/fieldTaxonomyRenderer/FieldTaxonomyRenderer.d.ts

@@ -0,0 +1,23 @@
+import * as React from 'react';
+import { ITerm } from '../../../common/SPEntities';
+import { IFieldRendererProps } from '../fieldCommon/IFieldRendererProps';
+export interface IFieldTaxonomyRendererProps extends IFieldRendererProps {
+    /**
+     * terms to display
+     */
+    terms: ITerm | ITerm[];
+}
+/**
+ * For future
+ */
+export interface IFieldTaxonomyRendererState {
+}
+/**
+ * Field Taxonomy Renderer.
+ * Used for:
+ *   - Taxonomy
+ */
+export declare class FieldTaxonomyRenderer extends React.Component<IFieldTaxonomyRendererProps, IFieldTaxonomyRendererState> {
+    constructor(props: IFieldTaxonomyRendererProps, state: IFieldTaxonomyRendererState);
+    render(): JSX.Element;
+}

package/dist/richTextEditor/components/filePicker/components/fields/fieldTaxonomyRenderer/index.d.ts

@@ -0,0 +1,2 @@
+export * from './FieldTaxonomyRenderer.module.scss';
+export * from './FieldTaxonomyRenderer';

package/dist/richTextEditor/components/filePicker/components/fields/fieldTextRenderer/FieldTextRenderer.d.ts

@@ -0,0 +1,35 @@
+import * as React from 'react';
+import { IFieldRendererProps } from '../fieldCommon/IFieldRendererProps';
+export interface IFieldTextRendererProps extends IFieldRendererProps {
+    /**
+     * text to be displayed
+     */
+    text?: string;
+    /**
+     * true if props.text can be inserted as innerHTML of the component
+     */
+    isSafeForInnerHTML?: boolean;
+    /**
+     * true if the text should be truncated
+     */
+    isTruncated?: boolean;
+}
+/**
+ * For future
+ */
+export interface IFieldTextRendererState {
+}
+/**
+ * Field Text Renderer.
+ * Used for:
+ *   - Single line of text
+ *   - Multiline text
+ *   - Choice
+ *   - Checkbox
+ *   - Number
+ *   - Currency
+ */
+export declare class FieldTextRenderer extends React.Component<IFieldTextRendererProps, IFieldTextRendererState> {
+    constructor(props: IFieldTextRendererProps, state: IFieldTextRendererState);
+    render(): JSX.Element;
+}

package/dist/richTextEditor/components/filePicker/components/fields/fieldTextRenderer/index.d.ts

@@ -0,0 +1,2 @@
+export * from './FieldTextRenderer.module.scss';
+export * from './FieldTextRenderer';

package/dist/richTextEditor/components/filePicker/components/fields/fieldTitleRenderer/FieldTitleRenderer.d.ts

@@ -0,0 +1,50 @@
+import * as React from 'react';
+import { IFieldRendererProps } from '../fieldCommon/IFieldRendererProps';
+export interface IFieldTitleRendererProps extends IFieldRendererProps {
+    /**
+     * text to be displayed
+     */
+    text?: string;
+    /**
+     * true if the Title should be rendered as link
+     */
+    isLink?: boolean;
+    /**
+     * web url
+     */
+    baseUrl?: string;
+    /**
+     * list id
+     */
+    listId?: string;
+    /**
+     * item id
+     */
+    id?: number;
+    /**
+     * custom title click event handler. If not set Display form for the item will be displaed
+     */
+    onClick?: (args: IFieldTitleClickEventArgs) => void;
+}
+/**
+ * For future
+ */
+export interface IFieldTitleRendererState {
+}
+/**
+ * Title click event arguments
+ */
+export interface IFieldTitleClickEventArgs {
+    listId?: string;
+    id?: string;
+}
+/**
+ * Field Title Renderer.
+ * Used for:
+ *   - Title
+ */
+export declare class FieldTitleRenderer extends React.Component<IFieldTitleRendererProps, IFieldTitleRendererState> {
+    constructor(props: IFieldTitleRendererProps, state: IFieldTitleRendererState);
+    render(): JSX.Element;
+    private _onClick;
+}

package/dist/richTextEditor/components/filePicker/components/fields/fieldTitleRenderer/index.d.ts

@@ -0,0 +1 @@
+export * from './FieldTitleRenderer';

package/dist/richTextEditor/components/filePicker/components/fields/fieldUrlRenderer/FieldUrlRenderer.d.ts

@@ -0,0 +1,31 @@
+import * as React from 'react';
+import { IFieldRendererProps } from '../fieldCommon/IFieldRendererProps';
+export interface IFieldUrlRendererProps extends IFieldRendererProps {
+    /**
+     * text to be displayed
+     */
+    text?: string;
+    /**
+     * url
+     */
+    url: string;
+    /**
+     * if the field should be rendered as image
+     */
+    isImageUrl?: boolean;
+}
+/**
+ * For future
+ */
+export interface IFieldUrlRendererState {
+}
+/**
+ * Field URL Renderer.
+ * Used for:
+ *   - URL (Hyperlink, Image)
+ */
+export declare class FieldUrlRenderer extends React.Component<IFieldUrlRendererProps, IFieldUrlRendererState> {
+    constructor(props: IFieldUrlRendererProps, state: IFieldUrlRendererState);
+    render(): JSX.Element;
+    private _onImgClick;
+}

package/dist/richTextEditor/components/filePicker/components/fields/fieldUrlRenderer/index.d.ts

@@ -0,0 +1,2 @@
+export * from './FieldUrlRenderer.module.scss';
+export * from './FieldUrlRenderer';

package/dist/richTextEditor/components/filePicker/components/fields/fieldUserRenderer/FieldUserHoverCard.d.ts

@@ -0,0 +1,26 @@
+import * as React from 'react';
+import { IExpandingCardProps } from '@fluentui/react/lib/HoverCard';
+export interface IFieldUserHoverCardProps {
+    /**
+     * IExpandingCardProps
+     */
+    expandingCardProps: IExpandingCardProps;
+    /**
+     * User display name
+     */
+    displayName: string;
+    /**
+     * CSS styles to apply to the renderer
+     */
+    cssProps?: React.CSSProperties;
+}
+export interface IFieldUserHoverCardState {
+    contentRendered?: HTMLDivElement;
+}
+/**
+ * Component to render User name with related Hover Card
+ */
+export default class FieldUserHoverCard extends React.Component<IFieldUserHoverCardProps, IFieldUserHoverCardState> {
+    constructor(props: IFieldUserHoverCardProps);
+    render(): JSX.Element;
+}

package/dist/richTextEditor/components/filePicker/components/fields/fieldUserRenderer/FieldUserRenderer.d.ts

@@ -0,0 +1,103 @@
+import * as React from 'react';
+import { IContext } from '../../../common/interfaces';
+import { IPrincipal } from '../../../common/SPEntities';
+import { IFieldRendererProps } from '../fieldCommon/IFieldRendererProps';
+export interface IFieldUserRendererProps extends IFieldRendererProps {
+    /**
+     * users to be displayed
+     */
+    users?: IPrincipal[];
+    /**
+     * Customizer context
+     */
+    context: IContext;
+}
+/**
+ * Internal interface to work with user profile
+ */
+export interface IFieldUser {
+    /**
+     * display  name
+     */
+    displayName?: string;
+    /**
+     * job title
+     */
+    jobTitle?: string;
+    /**
+     * department
+     */
+    department?: string;
+    /**
+     * user id
+     */
+    id?: string;
+    /**
+     * avatar url
+     */
+    imageUrl?: string;
+    /**
+     * email
+     */
+    email?: string;
+    /**
+     * skype for business username
+     */
+    sip?: string;
+    /**
+     * true if the user is current user
+     */
+    currentUser?: boolean;
+    /**
+     * work phone
+     */
+    workPhone?: string;
+    /**
+     * cell phone
+     */
+    cellPhone?: string;
+    /**
+     * url to edit user profile in Delve
+     */
+    userUrl?: string;
+}
+export interface IFieldUserRendererState {
+    users?: IFieldUser[];
+}
+/**
+ * Field User Renderer.
+ * Used for:
+ *   - People and Groups
+ */
+export declare class FieldUserRenderer extends React.Component<IFieldUserRendererProps, IFieldUserRendererState> {
+    private _loadedUserProfiles;
+    private _userUrlTemplate;
+    constructor(props: IFieldUserRendererProps, state: IFieldUserRendererState);
+    UNSAFE_componentWillReceiveProps(nextProps: IFieldUserRendererProps): void;
+    render(): JSX.Element;
+    /**
+     * Renders compact part of user Hover Card
+     * @param index user index in the list of users/groups in the People and Group field value
+     * @param user IUser
+     */
+    private _onRenderCompactCard;
+    /**
+     * Renders expanded part of user Hover Card
+     * @param user IUser
+     */
+    private _onRenderExpandedCard;
+    /**
+     * Merges data from IPrincipal object and IUserProfileProperties object to IUser object
+     * @param principal IPrincipal
+     * @param userProfileProperties IUserProfileProperties
+     */
+    private _getUserFromPrincipalAndProps;
+    /**
+     * Get the template of url for editing user profile in Delve
+     */
+    private _getUserUrlTemplate;
+    /**
+     * Requests User Profile Properties
+     */
+    private _requestUserProfile;
+}

package/dist/richTextEditor/components/filePicker/components/fields/fieldUserRenderer/index.d.ts

@@ -0,0 +1,3 @@
+export * from './FieldUserRenderer.module.scss';
+export * from './FieldUserHoverCard';
+export * from './FieldUserRenderer';

package/dist/richTextEditor/components/filePicker/components/filePicker/FilePicker.d.ts

@@ -0,0 +1,45 @@
+import * as React from 'react';
+import { IFilePickerProps } from './IFilePickerProps';
+import { IFilePickerState } from './IFilePickerState';
+export declare class FilePicker extends React.Component<IFilePickerProps, IFilePickerState> {
+    private fileBrowserService;
+    private oneDriveService;
+    private orgAssetsService;
+    private fileSearchService;
+    private readonly themed;
+    constructor(props: IFilePickerProps);
+    componentDidMount(): Promise<void>;
+    /**
+     * componentWillReceiveProps lifecycle hook
+     *
+     * @param nextProps
+     */
+    UNSAFE_componentWillReceiveProps(nextProps: IFilePickerProps): void;
+    render(): JSX.Element;
+    /**
+     * Renders the panel header
+     */
+    private _renderHeader;
+    /**
+     * Open the panel
+     */
+    private _handleOpenPanel;
+    /**
+     * Closes the panel
+     */
+    private _handleClosePanel;
+    /**
+     * On save action
+     */
+    private _handleSave;
+    private _handleOnChange;
+    /**
+     * Changes the selected tab when a link is selected
+     */
+    private _handleLinkClick;
+    /**
+     * Prepares navigation panel options
+     */
+    private _getNavPanelOptions;
+    private getDefaultSelectedTabKey;
+}

package/dist/richTextEditor/components/filePicker/components/filePicker/FilePicker.themedStyles.d.ts

@@ -0,0 +1,28 @@
+import { IPalette } from '@fluentui/react/lib/Styling';
+export declare const getThemedStyles: (palette: Partial<IPalette>) => import("@fluentui/merge-styles/lib/IStyleSet").IProcessedStyleSet<{
+    navLink: {
+        color: string;
+    };
+    navLinkSelected: {
+        color: string;
+        backgroundColor: string;
+    };
+    nav: {
+        color: string;
+    };
+    navInner: {
+        color: string;
+    };
+    tabHeaderContainer: {
+        color: string;
+    };
+    breadcrumbNavItem: {
+        color: string;
+    };
+    tabHeader: {
+        color: string;
+    };
+    actionButtonsContainer: {
+        backgroundColor: string;
+    };
+}>;

package/dist/richTextEditor/components/filePicker/components/filePicker/FilePicker.types.d.ts

@@ -0,0 +1,46 @@
+import { BaseComponentContext } from '@microsoft/sp-component-base';
+import { IBreadcrumbItem } from '@fluentui/react/lib/Breadcrumb';
+import { IFolder, ILibrary } from '../../services/FileBrowserService.types';
+export interface FilePickerBreadcrumbItem extends IBreadcrumbItem {
+    libraryData?: ILibrary;
+    folderData?: IFolder;
+}
+export interface IFilePickerTab {
+    context: BaseComponentContext;
+    accepts: string[];
+    onSave: (value: IFilePickerResult[]) => void;
+    onClose: () => void;
+}
+/**
+ * Represents the result of the FilePicker.
+ */
+export interface IFilePickerResult {
+    /**
+     * Selected file name with extension.
+     */
+    fileName: string;
+    /**
+     * Selected file name without extension.
+     */
+    fileNameWithoutExtension: string;
+    /**
+     * Absolute file URL. Undefined in case of file upload.
+     */
+    fileAbsoluteUrl: string;
+    /**
+     * Size of a selected file (in bytes). Undefined in all cases but file upload
+     */
+    fileSize?: number;
+    /**
+     * Absolute not modified file SharePoint URL.
+     */
+    spItemUrl?: string;
+    /**
+     * Downloads file picker result content.
+     */
+    downloadFileContent: () => Promise<File>;
+    /**
+     * Preview
+     */
+    previewDataUrl?: string;
+}

package/dist/richTextEditor/components/filePicker/components/filePicker/IFilePickerProps.d.ts

@@ -0,0 +1,147 @@
+import { WebPartContext } from '@microsoft/sp-webpart-base';
+import { IIconProps } from '@fluentui/react/lib/Icon';
+import { IFilePickerResult } from './FilePicker.types';
+export interface IFilePickerProps {
+    /**
+     * Specifies the text describing the file picker
+     */
+    label?: string;
+    /**
+     * Specifies the label of the file picker button
+     */
+    buttonLabel?: string;
+    /**
+     * Specifies the icon to be used to display Icon Button.
+     */
+    buttonIcon?: string;
+    /**
+     * Specifies props for icon to be used to display Icon Button.
+     */
+    buttonIconProps?: IIconProps;
+    /**
+     * Handler when the file has been selected
+     */
+    onSave: (filePickerResult: IFilePickerResult[]) => void;
+    /**
+     * Handler when file has been changed.
+     */
+    onChange?: (filePickerResult: IFilePickerResult[]) => void;
+    /**
+     * Current context.
+     */
+    context: WebPartContext;
+    /**
+     * ClassName to be applied to the opener button element.
+     */
+    buttonClassName?: string;
+    /**
+     * ClassName to be applied to the Panel root element.
+     */
+    panelClassName?: string;
+    /**
+     * File extensions to be displayed.
+     */
+    accepts?: string[];
+    /**
+     * Sets the label to inform that the value is required.
+     */
+    required?: boolean;
+    /**
+     * Used to execute WebSearch. If not provided SearchTab will not be available.
+     */
+    bingAPIKey?: string;
+    /**
+     * Specifies if the picker button is disabled
+     */
+    disabled?: boolean;
+    /**
+     * Specifies if the picker button is hidden (if hidden, panel visibility can still be controlled with isPanelOpen)
+     */
+    hidden?: boolean;
+    /**
+     * Number of itmes to obtain when executing REST queries. Default 100.
+     */
+    itemsCountQueryLimit?: number;
+    /**
+     * Specifies if RecentTab should be hidden.
+     */
+    hideRecentTab?: boolean;
+    /**
+     * Specifies if StockImagesTab should be hidden.
+     */
+    hideStockImages?: boolean;
+    /**
+     * Specifies if WebSearchTab should be hidden.
+     */
+    hideWebSearchTab?: boolean;
+    /**
+     * Specifies if OrganisationalAssetTab should be hidden.
+     */
+    hideOrganisationalAssetTab?: boolean;
+    /**
+     * Specifies if OneDriveTab should be hidden.
+     */
+    hideOneDriveTab?: boolean;
+    /**
+     * Specifies if SiteFilesTab should be hidden.
+     */
+    hideSiteFilesTab?: boolean;
+    /**
+     * Specifies if LocalUploadTab should be hidden.
+     */
+    hideLocalUploadTab?: boolean;
+    /**
+     * Specifies if LocalMultipleUploadTab should be hidden.
+     */
+    hideLocalMultipleUploadTab?: boolean;
+    /**
+     * Specifies if LinkUploadTab should be hidden.
+     */
+    hideLinkUploadTab?: boolean;
+    /**
+     * Specifies if last active tab will be stored after the Upload panel has been closed.
+     * Note: the value of selected tab is stored in the queryString hash.
+     * @default true
+     */
+    storeLastActiveTab?: boolean;
+    /**
+     * Specifies if the file picker panel is open by default or not
+     */
+    isPanelOpen?: boolean;
+    /**
+     * Handler when file picker has been cancelled.
+     */
+    onCancel?: () => void;
+    /**
+     * Optional additional renderer for Link tab
+     */
+    renderCustomLinkTabContent?: (filePickerResult: IFilePickerResult) => JSX.Element | null;
+    /**
+     * Optional additional renderer for Upload tab
+     */
+    renderCustomUploadTabContent?: (filePickerResult: IFilePickerResult) => JSX.Element | null;
+    /**
+     * Optional additional renderer for Multiple Upload tab
+     */
+    renderCustomMultipleUploadTabContent?: (filePickerResult: IFilePickerResult[]) => JSX.Element | null;
+    /**
+     * Specifies if Site Pages library to be visible on Sites tab
+     */
+    includePageLibraries?: boolean;
+    /**
+     * Specifies a default folder to be active in the Site Files tab
+     */
+    defaultFolderAbsolutePath?: string;
+    /**
+     * Specifies a default site in the Site Files tab
+     */
+    webAbsoluteUrl?: string;
+    /**
+     * Specifies if external links are allowed
+     */
+    allowExternalLinks?: boolean;
+    /**
+     * Specifies if file check should be done
+     */
+    checkIfFileExists?: boolean;
+}

package/dist/richTextEditor/components/filePicker/components/filePicker/IFilePickerState.d.ts

@@ -0,0 +1,7 @@
+export interface IFilePickerState {
+    showFullNav?: boolean;
+    panelOpen?: boolean;
+    selectedTab?: string;
+    webTitle?: string;
+    organisationAssetsEnabled?: boolean;
+}

package/dist/richTextEditor/components/filePicker/components/filePicker/LinkFilePickerTab/ILinkFilePickerTabProps.d.ts

@@ -0,0 +1,8 @@
+import { FilesSearchService } from '../../../services/FilesSearchService';
+import { IFilePickerResult, IFilePickerTab } from '../FilePicker.types';
+export interface ILinkFilePickerTabProps extends IFilePickerTab {
+    allowExternalLinks: boolean;
+    checkIfFileExists: boolean;
+    fileSearchService: FilesSearchService;
+    renderCustomLinkTabContent: (filePickerResult: IFilePickerResult) => JSX.Element | null;
+}

package/dist/richTextEditor/components/filePicker/components/filePicker/LinkFilePickerTab/ILinkFilePickerTabState.d.ts

@@ -0,0 +1,5 @@
+import { IFilePickerResult } from '../FilePicker.types';
+export interface ILinkFilePickerTabState {
+    filePickerResult?: IFilePickerResult;
+    isValid: boolean;
+}

package/dist/richTextEditor/components/filePicker/components/filePicker/LinkFilePickerTab/LinkFilePickerTab.d.ts

@@ -0,0 +1,30 @@
+import * as React from 'react';
+import { ILinkFilePickerTabProps } from './ILinkFilePickerTabProps';
+import { ILinkFilePickerTabState } from './ILinkFilePickerTabState';
+export default class LinkFilePickerTab extends React.Component<ILinkFilePickerTabProps, ILinkFilePickerTabState> {
+    constructor(props: ILinkFilePickerTabProps);
+    render(): React.ReactElement<ILinkFilePickerTabProps>;
+    /**
+     * Called as user types in a new value
+     */
+    private _handleChange;
+    /**
+     * Verifies the url that was typed in
+     * @param value
+     */
+    private _getErrorMessagePromise;
+    /**
+     * Handles when user saves
+     */
+    private _handleSave;
+    /**
+     * HAndles when user closes without saving
+     */
+    private _handleClose;
+    /**
+     * Is this a URL ?
+     * (insert guy holding a butterfly meme)
+     */
+    private _isUrl;
+    private _isSameDomain;
+}

package/dist/richTextEditor/components/filePicker/components/filePicker/LinkFilePickerTab/index.d.ts

@@ -0,0 +1,3 @@
+export * from './LinkFilePickerTab';
+export * from './ILinkFilePickerTabProps';
+export * from './ILinkFilePickerTabState';