Classes
The following classes are available globally.
-
An attachment can be used as a container for any view object. Based on the
See moreAttachmentSizeprovided, the attachment automatically renders itself alongside the text inEditorView.Attachmentalso provides helper functions likedeleteFromContainerandrangeInContainerDeclaration
Swift
open class Attachment : NSTextAttachment, BoundsObserving -
Shadow style for
See morebackgroundStyleattributeDeclaration
Swift
public class ShadowStyle -
Border style for
See morebackgroundStyleattributeDeclaration
Swift
public class BorderStyle -
Style for background color attribute. Adding
backgroundStyleattribute will add border, background and shadow as per the styles specified.Important
This attribute is separate frombackgroundColorattribute. ApplyingbackgroundColortakes precedence over backgroundStyle i.e. the background color shows over color ofbackgroundStyleand will not show rounded corners.See moreNote
IdeallybackgroundStylemay be used instead ofbackgroundColoras it can mimic standard background color as well as border, shadow and rounded corners.Declaration
Swift
public class BackgroundStyle -
A scrollable, multiline text region capable of resizing itself based of the height of the content. Maximum height of
See moreEditorViewmay be restricted using an absolute value or by using auto-layout constraints. Instantiation ofEditorViewis simple and straightforward and can be used to host simple formatted text or complex layout containing multiple nestedEditorViewvia use ofAttachment.Declaration
Swift
open class EditorView : UIViewextension EditorView: DefaultTextFormattingProviding -
Describes the context for the
See moreEditorView. A context is used to execute the commands usingEditorCommandExecutor. In a typical scenario, where there are multiple levels ofEditorViews that are contained in anotherEditorViewby virtue of being inAttachments, all theEditorViews sharing the same context automatically share theEditorCommandExecutor. i.e. theEditorCommandExecutoroperates on only thoseEditorViews which have the same context as provided to theEditorCommandExecutor.Declaration
Swift
public class EditorViewContext -
Editor command that toggles given attributes in selected range in the Editor.
See moreDeclaration
Swift
public class AttributesToggleCommand : EditorCommand -
Editor command that toggles Bold attribute to the selected range in the Editor.
See moreDeclaration
Swift
public class BoldCommand : FontTraitToggleCommand -
Editor command that toggles given font trait to the selected range in the Editor.
See moreDeclaration
Swift
public class FontTraitToggleCommand : EditorCommand -
Editor command that toggles Italics attribute to the selected range in the Editor.
See moreDeclaration
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 moreDeclaration
Swift
public class ListCommand : EditorCommand -
Command that can be used to toggle list indentation of selected range of text.
See moreDeclaration
Swift
public class ListIndentCommand : EditorCommand -
Command that can be used to toggle list indentation of selected range of text.
See moreDeclaration
Swift
public class ListOutdentCommand : EditorCommand -
Undocumented
See moreDeclaration
Swift
public class StrikethroughCommand : AttributesToggleCommand -
Undocumented
See moreDeclaration
Swift
public class UnderlineCommand : AttributesToggleCommand -
See moreEditorCommandExecutormanages all theEditorViewin the mainEditorView. Sub editors may have been added asAttachmentin theEditorView. All theEditorViews in the hierarchy sharing the sameEditorContextwill automatically be handled by theEditorCommandExecutor.EditorCommandExecutorkeeps the track of theEditorViewthat has the focus and executes the given command in the activeEditorView.Declaration
Swift
public class EditorCommandExecutor -
Declaration
Swift
open class GridCellextension GridCell: BoundsObservingextension GridCell: EditorViewDelegateextension GridCell: Equatableextension GridCell: Hashable -
A view that provides a tabular structure where each cell is an
See moreEditorView. Since the cells contains anEditorViewin itself, it is capable of hosting any attachment thatEditorViewcan host including anotherGridViewas an attachment.Declaration
Swift
public class GridView : UIViewextension GridView: UIScrollViewDelegateextension GridView: AsyncDeferredRenderableextension GridView: BackgroundColorObserving -
Undocumented
See moreDeclaration
Swift
public class Utility -
Undocumented
See moreDeclaration
Swift
public class TableCellextension TableCell: Equatableextension TableCell: Hashable -
Undocumented
See moreDeclaration
Swift
public class TableCellContentView : UIViewextension TableCellContentView: BoundsObservingextension TableCellContentView: EditorViewDelegate -
A view that provides a tabular structure where each cell is an
See moreEditorView. Since the cells contains anEditorViewin itself, it is capable of hosting any attachment thatEditorViewcan host including anotherTableViewas an attachment.Declaration
Swift
public class TableView : UIViewextension TableView: UIScrollViewDelegateextension TableView: AsyncDeferredRenderableextension TableView: BackgroundColorObserving -
Text process capable of processing keyboard inputs specific to lists.
ListTextProcessoronly works after a range of text has been converted to list usingListCommand.Supports the following inputs:
- 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.
- Shift-Enter: Adds a soft line break i.e. does not create a new list item but moves to next line.
- 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.
- Shift-Tab: Outdents text in list by one level each time. Using this on first level exits the list formatting for given text.
Declaration
Swift
open class ListTextProcessor : TextProcessing
View on GitHub
Classes Reference