Home Reference Source

References

Class Summary

Static Public Class Summary
public
public
public
public
public

Interact with assignment API service

public

Assignment Flux store.

public
public
public

Floating search result menu.

public

Single menu item component.

public

Interact with author API service

public
public

Author Flux store.

public

Services extend the base service to provide standard access methods.

public
public
public
public
public

Character counter

public

Render the new comment box and container for individual note comments.

public
public

Interact with container API service

public
public

Container Flux store.

public
public
public
public
public
public
public
public
public

Render single content search result

public

Interact with content API service

public
public

Copy notes live in the editor's metdata and so are only tracked via an internal, read-only, stack here.

You shouldn't need to interact with this outside the NoteViewer component.

public
public
public
public
public
public
public

Hold to delete button.

public

Diff accepts two HTML strings and displays a marked up diff of the two

public
public

Last autosave notification, accepts properties:

  • label - notification text
  • format - timeformat (moment)
  • lastsave - date object
public

Draft restore notification, accepts

  • onRestore - callback
  • pendingDraft - immutable map
  • label - notification text
  • buttonLabel - label text for restore button
  • buttonClass = class(es) for restore button
public

Interact with draft API service

public

Draft Flux store.

public

Pure React dropdown that doesn't rely on jQuery or Materialize at all. Works similar to the React-Materialize dropdown component: <Dropdown trigger={ <Button className='btn btn-block btn-small'><i className="fa fa-plus"></i></Button> }> <DropdownItem><Link to='/ceo/content/new'>Content</Link></DropdownItem> <DropdownItem><Link to='/ceo/assignment/new'>Assignment</Link></DropdownItem> </Dropdown>

public
public
public
public
public

Errors live in internal stack.

public
public
public

Internal event system, based on EventEmitter2.

public
public
public
public
public
public
public
public

Fake MaterialUI icon button here because we're using the FontAwesome icons and they're not the same size.

public
public

Wrapper for materialize spinner

public
public
public
public
public

MediaResize component handles the draggable resizing of media blocks.

public
public
public
public

NoteBox component renders the note container and its children.

public
public

Note comments are fetched from API and injected into the NoteViewer.

public
public
public

Pagination component.

public
public

Quip component, mostly for fun and personality.

public

ReduxPagination stateful component.

public
public

Request class is similar to those in other frameworks allowing easy, quick access to param info.

public
public

Render single media search result

public
public

The idea here is you generate a unique ID and a component then emit an addRootComponent event with the id and component and it is injected here.

public
public
public

Custom exception to handle HTTP errors from the services.

public

The SimpleEditor is a stripped down version of the RichEditor.

public

Instace wrapper if you don't or can't use the singleton action and classes.

public

Render a single note or comment

public

Pagination component.

public

Splash screen that sits in front of loading application.

public
public
public
public
public
public
public
public
public
public

Floating search result menu.

public

Single menu item component.

public

Interact with tag API service

public
public

Tag Flux store.

public
public
public
public
public

UrlHandler is a custom component for the content form that handles display of default URLs and management of custom ones.

public

Single selected user item.

public

Floating search result menu.

public

Single menu item component.

public

Interact with user API service

public

User Flux store.

public

Interact with version API service

public

Versions Flux store.

public

Word counter

Function Summary

Static Public Function Summary
public

AnchorPlugin(options: *): *

public

CqPlugin(options: *): *

public

EmbedPlugin(options: *): *

public

GridPlugin(options: *): *

public

HrPlugin(options: *): *

public

MediaPlugin(options: *): *

public

NotePlugin(options: *): *

public

StylerPlugin(options: *): *

public

SuggestionPlugin(options: *): *

public

TablePlugin(options: *): *

public

aclReceive(acl: *): *

public

aclSetSelected(acl: *): *

public

aclUpdate(acl: {}): *

public

acls(state: *, action: *): *

public

aclsFetch(params: {}): *

public

aclsFetchOne(id: *): *

public
public
public

aclsMaybeFetch(params: {}): *

public

aclsReceive(items: *): *

public

aclsRemove(names: *): *

public

aclsRequest(params: {}): *

public

aclsResourcesReceive(resources: *): *

public

aclsSetPage(page: number): *

Action creators

public

aclsShouldFetch(state: *): *

public

alertClose(): *

public

alertShowMessage(options: *): *

Action creators

public

anchorClickHandler(e: *, defaultUrl: string)

public

application(state: *, action: *): *

public
public
public
public

applicationIsDirty(mcGurt: *): *

public
public

applicationSetPlugins(plugins: *): *

public

applicationSetSettings(settings: *): *

public

Action Creators

public

applicationUpdateSetting(slug: *, value: *): *

public

assignmentComments(state: *, action: *): *

public

assignmentCommentsCreate(id: *, comment: {}): *

public

assignmentCommentsFetch(id: *, params: {}): *

public
public
public
public

assignmentCommentsRequest(params: {}): *

Action creators

public

assignmentView(state: *, action: *): *

public
public
public
public

assignmentViewUpdate(params: {}): *

Action creators

public

assignments(state: *, action: *): *

public

assignmentsCheckIn(uuid: *, lockUuid: *): *

public

assignmentsCheckOut(srn: *): *

public

assignmentsClearLock(userUuid: *, lockUuid: *): *

public

assignmentsCreate(assignment: {}): *

public

assignmentsFetch(params: {}): *

public
public
public

assignmentsMaybeFetch(params: {}): *

public
public

assignmentsReceive(items: *): *

public

assignmentsReceiveOne(item: *): *

public
public

assignmentsReceivePagination(pagination: *): *

Action creators

public

assignmentsReceiveWebSocket(assignments: {}): *

public

assignmentsRemove(uuids: *): *

public

assignmentsRequest(params: {}): *

public

assignmentsSetSelected(assignment: *): *

public

assignmentsShouldFetch(state: *): *

public

assignmentsUpdate(id: *, assignment: {}): *

public

authorCreate(data: *): *

public

authorReceive(author: *): *

public

authorSetSelected(author: *): *

public

authorUpdate(id: *, data: *): *

public

authors(state: *, action: *): *

public

authorsFetch(params: {}): *

public

authorsFetchOne(id: *): *

public
public

authorsMaybeFetch(params: {}): *

public

authorsReceive(items: *): *

public

authorsReceivePagination(pagination: *): *

Action creators

public

authorsRemove(uuid: *): *

public

authorsRequest(params: {}): *

public

authorsShouldFetch(state: *): *

public

buildQuery(query: *): *

public

buildRoutes(store: *): *

Handle current app routes

public

channelCreate(data: *): *

public

channelReceive(channel: *): *

public

channelSetSelected(channel: *): *

public

channelUpdate(id: *, data: *): *

public

channels(state: *, action: *): *

public

channelsFetch(params: {}): *

public

channelsFetchOne(id: *): *

public
public

channelsMaybeFetch(params: {}): *

public

channelsReceive(items: *): *

public

channelsReceivePagination(pagination: *): *

Action creators

public

channelsRemove(uuid: *): *

public

channelsRequest(params: {}): *

public

channelsShouldFetch(state: *): *

public

combineRules(ruleSet: *): *

public

containerCreate(container: {}): *

public

containerFetchOne(id: *): *

public

containerReceive(item: *): *

public

containerSetSelected(container: *): *

public

containerUpdate(id: *, container: {}): *

public

containers(state: *, action: *): *

public

containersCheckIn(uuid: *, lockUuid: *): *

public

containersCheckOut(srn: *): *

public

containersFetch(params: {}): *

public
public

containersMaybeFetch(params: {}): *

public

containersReceive(items: *): *

public

containersReceivePagination(pagination: *): *

Action creators

public

containersRemove(uuids: *): *

public

containersRequest(params: {}): *

public

containersShouldFetch(state: *): *

public

content(state: *, action: *): *

public

contentAttachmentUpdate(id: *, data: {}): *

public

contentCheckIn(uuid: *, lockUuid: *): *

public

contentCheckOut(srn: *): *

public

contentClearLock(userUuid: *, lockUuid: *): *

public

contentCreate(content: {}): *

public

contentDeleteFromWebSocket(content: {}): *

public

contentFetch(params: {}): *

public

contentFetchOne(id: *): *

public

contentFetchOne(content: *, version: *, params: {}): *

public
public

contentMaybeFetch(params: {}): *

public
public

contentReceive(items: *): *

public

contentReceiveOne(item: *): *

public
public

contentReceivePagination(pagination: *): *

Action creators

public

contentReceiveWebSocket(content: {}): *

public

contentRemove(uuids: *): *

public

contentRemoveOne(item: *): *

public

contentRequest(params: {}): *

public
public

contentSearchFetch(params: {}): *

public
public

contentSearchReceive(items: *): *

public

contentSearchReceivePagination(pagination: *): *

public

contentSearchRequest(params: {}): *

Action creators

public
public

contentSetSelected(content: *): *

public

contentShouldFetch(state: *): *

public

contentSyncPrint(uuid: *): *

public

contentUpdate(id: *, content: {}): *

public
public

contentVersionReceive(items: *): *

public
public

contentVersionRequest(params: {}): *

Action creators

public

contentVersionRestore(uuid: *): *

public
public

contentVersionsFetch(srn: *, params: {}): *

public

contentView(state: *, action: *): *

public
public
public
public

contentViewUpdate(params: {}): *

Action creators

public
public
public

ensureEmptyGraf(editor: *)

public

entries(state: *, action: *): *

public

entriesFetch(params: {}): *

public

entriesFetchNoSideEffect(params: {}): *

public

entriesFetchOne(id: *): *

public
public

entriesMaybeFetch(params: {}): *

public

entriesReceive(items: *): *

public

entriesReceivePagination(pagination: *): *

Action creators

public

entriesRemove(uuid: *): *

public

entriesRequest(params: {}): *

public

entriesShouldFetch(state: *): *

public

entryCreate(data: *): *

public

entryReceive(entry: *): *

public

entrySetSelected(entry: *): *

public

entryUpdate(id: *, data: *): *

public

globalHistory(state: *, action: *): *

public
public

globalHistoryPush(object: *): *

Action creators

public

globalSearch(state: *, action: *): *

public

globalSearchFetch(params: {}): *

public
public

globalSearchReceive(items: *): *

public

globalSearchReceivePagination(pagination: *): *

Action creators

public

globalSearchRemember(query: *): *

public

globalSearchRequest(params: {}): *

public
public
public
public
public
public

isMonkeyClawPlus(e: *, key: *): *

public
public

isPrimaryPlus(e: *, key: *): *

public
public

isSecondaryPlus(e: *, key: *): *

public

issueCreate(issue: {}): *

public

issueReceive(item: *): *

public

issueSetSelected(issue: *): *

public

issueUpdate(id: *, issue: {}): *

public

issues(state: *, action: *): *

public

issuesFetch(params: {}): *

public

issuesFetchOne(id: *): *

public
public
public
public
public

issuesMaybeFetch(params: {}): *

public

issuesReceive(items: *): *

public

issuesReceivePagination(pagination: *): *

Action creators

public

issuesRemove(uuids: *): *

public

issuesRequest(params: {}): *

public

issuesShouldFetch(state: *): *

public

linkStrategy(contentBlock: *, callback: *)

RegEx the provided content block text to look for valid links.

public

mentionStrategy(contentBlock: *, callback: *)

public

noteCommentCreate(ref: *, data: *): *

public

noteCommentReceive(noteComment: *): *

public

noteCommentSetSelected(noteComment: *): *

public

noteCommentUpdate(id: *, data: *): *

public

noteComments(state: *, action: *): *

public

noteCommentsFetch(ref: *, params: {}): *

public
public
public

noteCommentsIsFetching(isFetching: *): *

public

noteCommentsMaybeFetch(params: {}): *

public

noteCommentsReceive(items: *): *

public

noteCommentsRemove(uuid: *): *

public

noteCommentsRequest(params: {}): *

public

site(state: *, action: *): *

public

siteCreateRoute(data: {}): *

public

siteFetch(params: {}): *

public

siteFetchRoutes(params: {}): *

public

siteFetchSsl(params: {}): *

public
public

siteMaybeFetch(params: {}): *

public

siteReceive(items: *): *

public

siteReceiveRoutes(items: *): *

public

siteReceiveSsl(items: *): *

public

siteRemoveRoute(uuid: *): *

public

siteRequest(params: {}): *

Action creators

public

siteShouldFetch(state: *): *

public

siteUpdateRoute(uuid: *, data: {}): *

public

smartquotes(options: {}): *

public

snackbar(state: *, action: *): *

public
public

snackbarShowMessage(message: *, duration: number): *

Action creators

public

softbreaks(options: {}): *

public

sstsCreate(data: *): *

public

sstsReceive(ssts: *): *

public

sstsSetSelected(ssts: *): *

public

sstsUpdate(id: *, data: *): *

public

sstsUpdateMultiple(data: *): *

public

sstss(state: *, action: *): *

public

sstssFetch(params: {}): *

public

sstssFetchOne(id: *): *

public
public

sstssMaybeFetch(params: {}): *

public

sstssReceive(items: *): *

public

sstssReceivePagination(pagination: *): *

Action creators

public

sstssRemove(uuid: *): *

public

sstssRequest(params: {}): *

public

sstssShouldFetch(state: *): *

public

stylerClickHandler(e: *, defaultUrl: string)

public
public

systemAlert(state: *, action: *): *

public
public

tableAddRow(e: *)

public
public
public
public

tagCreate(data: *): *

public

tagReceive(tag: *): *

public

tagSetSelected(tag: *): *

public

tagUpdate(id: *, data: *): *

public

tags(state: *, action: *): *

public

tagsFetch(params: {}): *

public

tagsFetchOne(id: *): *

public
public

tagsMaybeFetch(params: {}): *

public

tagsReceive(items: *): *

public

tagsReceivePagination(pagination: *): *

Action creators

public

tagsRemove(uuid: *): *

public

tagsRequest(params: {}): *

public

tagsShouldFetch(state: *): *

public

toast(message: string)

Just fire a tost event

public

uploadCart(state: *, action: *): *

public

uploadCartSetItems(items: *): *

Action creators

public

userCreate(data: *): *

public

userReceive(user: *): *

public

userSetSelected(user: *): *

public

userUpdate(id: *, data: *): *

public

userUpdateMe(data: *): *

public

users(state: *, action: *): *

public

usersFetch(params: {}): *

public

usersFetchOne(id: *): *

public
public

usersMaybeFetch(params: {}): *

public

usersReceive(items: *): *

public

usersReceivePagination(pagination: *): *

Action creators

public

usersRemove(uuid: *): *

public

usersRequest(params: {}): *

public

usersSearch(params: {}): *

public

usersShouldFetch(state: *): *

public

workflowCreate(workflow: {}): *

public

workflowReceive(item: *): *

public

workflowSectionCreate(workflowSection: {}): *

public
public

workflowSectionSetSelected(workflowSection: *): *

public

workflowSectionUpdate(id: *, workflowSection: {}): *

public

workflowSections(state: *, action: *): *

public

workflowSectionsFetch(params: {}): *

public
public
public
public
public
public
public

workflowSectionsRemove(uuids: *): *

public

workflowSectionsRequest(params: {}): *

Action creators

public
public
public

workflowSetSelected(workflow: *): *

public

workflowUpdate(id: *, workflow: {}): *

public

workflows(state: *, action: *): *

public

workflowsFetch(params: {}): *

public

workflowsFetchOne(id: *): *

public
public
public
public
public
public

workflowsMaybeFetch(params: {}): *

public

workflowsReceive(items: *): *

public

workflowsRemove(uuids: *): *

public

workflowsRequest(params: {}): *

Action creators

public

workflowsSetPriority(uuids: *): *

public

workflowsShouldFetch(state: *): *

Variable Summary

Static Public Variable Summary
public
public
public

Action types

public
public
public
public
public
public

Action Types

public
public
public
public
public
public
public
public
public

Action Types

public
public
public
public
public
public

Action types

public
public
public
public

Action types

public
public
public
public
public

Action types

public
public
public
public

Action types

public
public
public
public

Render block styling buttons

public
public
public
public

Action types

public
public
public
public
public
public

Action types

public
public
public
public
public
public
public
public
public

Action types

public
public
public
public

Action types

public
public
public
public
public
public

Action types

public

Config: *

public
public
public

Handle the currently logged ino user.

public
public
public
public
public

Action types

public
public
public
public

Render block styling buttons

public
public

Action types

public
public
public
public
public

Action types

public
public
public
public
public

Action types

public
public
public

Render inline styles

public

Simply wrap the link and provide a clickthrough

public
public
public
public
public

Action types

public
public
public
public

RULES: *

public
public
public
public
public
public
public
public
public
public
public
public
public
public
public

Action types

public
public

Action Types

public
public
public
public

Action types

public
public
public

Serializer: slate-html-serializer~Html

public
public
public
public

Action types

public
public
public

Action types

public
public
public
public

Action types

public
public
public
public
public
public

Action types

public
public
public
public
public
public
public
public

Action types

public
public
public
public
public
public

Action types

public
public
public
public
public

degraf: *

public

error: *

Error message, if debug is on

public
public
public

Encapsulates entity finder for drop caps

public
public
public

HTML String decoder Decode HTML5 entities

public

htmlDiff(strA: string, strB: string): string: *

HTML String diff

public

info: *

Info message, if debug is on

public
public

Simple callback to insert the hr wrapper into the editor

public
public

Simple callback to insert the quote wrapper into the editor

public
public
public
public
public
public

log: *

Log message, if debug is on

public

mentionModifier(editorState: *, store: *): *: *

Mention modifier injects the mentioned user name into the editor.

public
public

parameterize(obj: object, prefix: string): string: *

Convert hash into HTTP parameter string.

public

parseSrn(srn: string): object: *

Parse a SRN into its component parts

public

randomString(Max: integer): *

Generate random alpha numeric string.

public
public

Reduce slashes in an escaped string.

public
public

sluggify(str: string, allowTrailing: string): string: *

Convert a string into a URL slug

public

state: *

public

timeToFormat(time: string, fmt: string): string: *

Convert time to local string.

public

Simple callback to inject drop cap state

public

truncate(str: string, length: integer, trail: string): *

Truncate a string at character count, regardless of length or punctuation.

public

urlify(str: string, strip: boolean): string: *

Ensure a string is URL friendly.

public

warning: *

Warning message, if debug is on

public

withAtable(WrappedComponent: Object): Object: *

Atable HOC

public

withDraftable(WrappedComponent: Object): Object: *

Draftable HOC

public