Classes

The following classes are available globally.

  • An attachment can be used as a container for any view object. Based on the AttachmentSize provided, the attachment automatically renders itself alongside the text in EditorView. Attachment also provides helper functions like deleteFromContainer and rangeInContainer

    See more

    Declaration

    Swift

    open class Attachment : NSTextAttachment, BoundsObserving
  • Shadow style for backgroundStyle attribute

    See more

    Declaration

    Swift

    public class ShadowStyle
  • Border style for backgroundStyle attribute

    See more

    Declaration

    Swift

    public class BorderStyle
  • Style for background color attribute. Adding backgroundStyle attribute will add border, background and shadow as per the styles specified.

    Important

    This attribute is separate from backgroundColor attribute. Applying backgroundColor takes precedence over backgroundStyle i.e. the background color shows over color of backgroundStyle and will not show rounded corners.

    Note

    Ideally backgroundStyle may be used instead of backgroundColor as it can mimic standard background color as well as border, shadow and rounded corners.
    See more

    Declaration

    Swift

    public class BackgroundStyle
  • A scrollable, multiline text region capable of resizing itself based of the height of the content. Maximum height of EditorView may be restricted using an absolute value or by using auto-layout constraints. Instantiation of EditorView is simple and straightforward and can be used to host simple formatted text or complex layout containing multiple nested EditorView via use of Attachment.

    See more

    Declaration

    Swift

    open class EditorView : UIView
    extension EditorView: DefaultTextFormattingProviding
  • Describes the context for the EditorView. A context is used to execute the commands using EditorCommandExecutor. In a typical scenario, where there are multiple levels of EditorViews that are contained in another EditorView by virtue of being in Attachments, all the EditorViews sharing the same context automatically share the EditorCommandExecutor. i.e. the EditorCommandExecutor operates on only those EditorViews which have the same context as provided to the EditorCommandExecutor.

    See more

    Declaration

    Swift

    public class EditorViewContext
  • Editor command that toggles given attributes in selected range in the Editor.

    See more

    Declaration

    Swift

    public class AttributesToggleCommand : EditorCommand
  • Editor command that toggles Bold attribute to the selected range in the Editor.

    See more

    Declaration

    Swift

    public class BoldCommand : FontTraitToggleCommand
  • Editor command that toggles given font trait to the selected range in the Editor.

    See more

    Declaration

    Swift

    public class FontTraitToggleCommand : EditorCommand
  • Editor command that toggles Italics attribute to the selected range in the Editor.

    See more

    Declaration

    Swift

    public class ItalicsCommand : FontTraitToggleCommand
  • Command that can be used to toggle list attributes of selected range of text. If the length of selected range of text is 0, the attributes are applied on the current line of text.

    See more

    Declaration

    Swift

    public class ListCommand : EditorCommand
  • Command that can be used to toggle list indentation of selected range of text.

    See more

    Declaration

    Swift

    public class ListIndentCommand : EditorCommand
  • Command that can be used to toggle list indentation of selected range of text.

    See more

    Declaration

    Swift

    public class ListOutdentCommand : EditorCommand
  • Undocumented

    See more

    Declaration

    Swift

    public class StrikethroughCommand : AttributesToggleCommand
  • Undocumented

    See more

    Declaration

    Swift

    public class UnderlineCommand : AttributesToggleCommand
  • EditorCommandExecutor manages all the EditorView in the main EditorView. Sub editors may have been added as Attachment in the EditorView. All the EditorViews in the hierarchy sharing the same EditorContext will automatically be handled by the EditorCommandExecutor. EditorCommandExecutor keeps the track of the EditorView that has the focus and executes the given command in the active EditorView.

    See more

    Declaration

    Swift

    public class EditorCommandExecutor
  • Denotes a cell in the GridView

    See more

    Declaration

    Swift

    open class GridCell
    extension GridCell: BoundsObserving
    extension GridCell: EditorViewDelegate
    extension GridCell: Equatable
  • A view that provides a tabular structure where each cell is an EditorView. Since the cells contains an EditorView in itself, it is capable of hosting any attachment that EditorView can host including another GridView as an attachment.

    See more

    Declaration

    Swift

    public class GridView : UIView
    extension GridView: UIScrollViewDelegate
    extension GridView: AsyncDeferredRenderable
    extension GridView: BackgroundColorObserving
  • Text process capable of processing keyboard inputs specific to lists. ListTextProcessor only works after a range of text has been converted to list using ListCommand.

    Supports the following inputs:

    1. Enter: Creates a new list item at the same level as the current one. Using Enter twice in a row at the last list item exits list. When used twice in a row in the middle of a list, it only creates empty list items and does not exit list.
    2. Shift-Enter: Adds a soft line break i.e. does not create a new list item but moves to next line.
    3. Tab: Indents the current level to next indentation level. A level may only be indented 1 level deeper than previous level. First level items cannot be indented.
    4. Shift-Tab: Outdents text in list by one level each time. Using this on first level exits the list formatting for given text.
    See more

    Declaration

    Swift

    open class ListTextProcessor : TextProcessing