Options
All
  • Public
  • Public/Protected
  • All
Menu

Sitefinity Component framework API documentation

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

DataProperties

DataProperties: object

Type declaration

  • [key: string]: string

MarkupConfig

MarkupConfig: Map<string, MarkupSection[]>

MarkupSection

MarkupSection: ListSection | TextSection

TreeDataProperties

TreeDataProperties: object

Type declaration

  • [key: string]: string | Function

Variables

Const ARROW_HTML_TEMPLATE

ARROW_HTML_TEMPLATE: string = `<i class="sf-fa sf-fa-angle-right -sf-ml-4xs -sf-mr-4xs" aria-hidden="true"></i>`

Const ARROW_TEMPLATE

ARROW_TEMPLATE: string = ` > `

Const AUTO

AUTO: "auto" = "auto"

Const BLOCK_CLASS

BLOCK_CLASS: "-sf-block" = "-sf-block"

Const BOLD_CLOSE_TAG

BOLD_CLOSE_TAG: "</b>" = "</b>"

Const BOLD_OPEN_TAG

BOLD_OPEN_TAG: "<b>" = "<b>"

Const CHIP_WRAPPER_CLASS

CHIP_WRAPPER_CLASS: string = "sf-choice-group -chip"

Const CHOICE_CHIP_L

CHOICE_CHIP_L: number = 6

Const CHOICE_CHIP_L_CLS

CHOICE_CHIP_L_CLS: string = "-size-l"

Const CHOICE_CHIP_M

CHOICE_CHIP_M: number = 3

Const CHOICE_CHIP_M_CLS

CHOICE_CHIP_M_CLS: string = "-size-m"

Const CHOICE_COMPONENTS

CHOICE_COMPONENTS: SfRadioGroupComponent[] = [SfCheckboxesComponent, SfRadioGroupComponent, SfSelectComponent]

Const CODE_CLASS

CODE_CLASS: "-sf-txt-code" = "-sf-txt-code"

Const DEFAULT_MARKUP_KEY

DEFAULT_MARKUP_KEY: "DefaultMarkupKey" = "DefaultMarkupKey"

Const DIMMED_CLASS

DIMMED_CLASS: "-sf-txt-dimmed" = "-sf-txt-dimmed"

Const DRAGGING_CLASS

DRAGGING_CLASS: "-sf-tree-dragging" = "-sf-tree-dragging"

Const ENTER_KEY_CODE

ENTER_KEY_CODE: 13 = 13

Const ESCAPE_KEY_CODE

ESCAPE_KEY_CODE: 27 = 27

Const HEADING_CLASS

HEADING_CLASS: "h4 -sf-h-large" = "h4 -sf-h-large"

Const HTML_SPECIAL_CHARS_REGEX

HTML_SPECIAL_CHARS_REGEX: RegExp = /&[a-z0-9]+;/gim

Const JUST_ADDED_PROPERTY

JUST_ADDED_PROPERTY: string = "__sf__justAdded"

Const LETTER_PATTERN

LETTER_PATTERN: RegExp = /[a-z]+/i

Const LTR_CHARS_RANGE

LTR_CHARS_RANGE: "A-Za-zÀ-ÖØ-öø-ʸ̀-֐ࠀ-῿Ⰰ-﬜﷾-﹯﻽-￿" = "A-Za-zÀ-ÖØ-öø-ʸ̀-֐ࠀ-῿Ⰰ-﬜﷾-﹯﻽-￿"

Const ON_TOP_LEVEL

ON_TOP_LEVEL: string = "On top level"

Const PIPES

PIPES: (SfSafePipe | SfCapitalizePipe | SfHtmlEscapePipe | SfBreadcrumbPipe | SfSanitizerPipe)[] = [SfSafePipe,SfCapitalizePipe,SfBolderTextPipe,SfHtmlEscapePipe,SfBreadcrumbPipe,SfSanitizerPipe]

Const PX

PX: "px" = "px"

Const REMOVE_ANIMATION_CLASS_TIMEOUT

REMOVE_ANIMATION_CLASS_TIMEOUT: number = 1000

Const RTL_CHARS_RANGE

RTL_CHARS_RANGE: "֑-߿יִ-﷽ﹰ-ﻼ" = "֑-߿יִ-﷽ﹰ-ﻼ"

Const RTL_CLASS

RTL_CLASS: "-sf-direction-rtl" = "-sf-direction-rtl"

Const SCROLL_DURATION

SCROLL_DURATION: 250 = 250

Const SCROLL_STEP_DELAY

SCROLL_STEP_DELAY: 25 = 25

Const SF_DOCUMENT_TOKEN

SF_DOCUMENT_TOKEN: InjectionToken<unknown> = new InjectionToken("Document")

Const SF_WINDOW_TOKEN

SF_WINDOW_TOKEN: InjectionToken<unknown> = new InjectionToken("Window")

Const SHOULD_BE_RTL

SHOULD_BE_RTL: RegExp = new RegExp(`^[^+${LTR_CHARS_RANGE}+]*[${RTL_CHARS_RANGE}]`)

Const SITEFINITY_COMMON

SITEFINITY_COMMON: (SfTrackFocusDirective | SfTextDirectionDirective | SfUnitDirective | SfMoveInViewportDirective | SfCarretPositionDirective | SfSafePipe | SfCapitalizePipe | SfHtmlEscapePipe | SfBreadcrumbPipe | SfSanitizerPipe)[] = [SfTrackFocusDirective,SfTextDirectionDirective,SfUnitDirective,SfMoveInViewportDirective,SfCarretPositionDirective,...PIPES]

Const SITEFINITY_SERVICES_COMMON

SITEFINITY_SERVICES_COMMON: (SfScrollService | SfScrollDetectionService)[] = [SfScrollService,SfScrollDetectionService]

Const SPAN_CLOSE_TAG

SPAN_CLOSE_TAG: "</span>" = "</span>"

Const SPAN_OPEN_TAG

SPAN_OPEN_TAG: "<span>" = "<span>"

Const STARTS_WITH_CHARS

STARTS_WITH_CHARS: string[] = [stringConstants.INTERVAL,stringConstants.OPENING_BRACKET,stringConstants.OPENING_SQUARE_BRACKET,stringConstants.DASH,stringConstants.QUOTE]

Const SYMBOLS_COUNT_TO_TRIGGER_ANIMATION

SYMBOLS_COUNT_TO_TRIGGER_ANIMATION: 3 = 3

Const TAB_KEY_CODE

TAB_KEY_CODE: 9 = 9

Const TOP_LEVEL_MEMBER

TOP_LEVEL_MEMBER: number = 0

Const TOP_OFFSET

TOP_OFFSET: 0.25 = 0.25

Const TREE_CLASS_NAME

TREE_CLASS_NAME: "sf-tree" = "sf-tree"

Const UNDER

UNDER: string = "Under"

Const VISILBE_BREADCRUMB_MEMBERS

VISILBE_BREADCRUMB_MEMBERS: number = 2

Const ZERO

ZERO: "0" = "0"

Const buttonClass

buttonClass: "sf-button" = "sf-button"

Const buttonFeedbackIcon

buttonFeedbackIcon: "check" = "check"

Const buttonIconClass

buttonIconClass: "sf-button__icon sf-icon sf-fa sf-fa-" = "sf-button__icon sf-icon sf-fa sf-fa-"

Const fifthRectClass

fifthRectClass: "-fifth" = "-fifth"

Const firstRectClass

firstRectClass: "-first" = "-first"

Const fixedModifier

fixedModifier: "fixed" = "fixed"

Const fourthRectClass

fourthRectClass: "-fourth" = "-fourth"

Const iconClass

iconClass: "sf-icon" = "sf-icon"

Const inlineModifier

inlineModifier: "inline" = "inline"

Const inputClass

inputClass: "sf-input" = "sf-input"

Const loaderClass

loaderClass: "sf-loader" = "sf-loader"

Const notificationClass

notificationClass: "sf-notification" = "sf-notification"

Const secondRectClass

secondRectClass: "-second" = "-second"

Const singleRowHeight

singleRowHeight: 16 = 16

Const sixthRectClass

sixthRectClass: "-sixth" = "-sixth"

Const thirdRectClass

thirdRectClass: "-third" = "-third"

Const tooltipModifier

tooltipModifier: "tooltip" = "tooltip"

Functions

Const noop

  • noop(): void
  • Returns void

provideDocumentFactory

  • provideDocumentFactory(): Document
  • Returns Document

queryAllByCss

  • queryAllByCss(f: any, css: string): DebugElement[]
  • Match elements by the given CSS selector. Return an array with matched elements

    Parameters

    • f: any
    • css: string

    Returns DebugElement[]

queryByCss

  • queryByCss(f: any, css: string): DebugElement
  • Match elements by the given CSS selector. Return the first matched element

    Parameters

    • f: any
    • css: string

    Returns DebugElement

sfGetWindowFactory

  • sfGetWindowFactory(): Window & globalThis
  • Returns Window & globalThis

Object literals

Const CUSTOM_INPUT_CONTROL_VALUE_ACCESSOR

CUSTOM_INPUT_CONTROL_VALUE_ACCESSOR: object

multi

multi: boolean = true

provide

provide: InjectionToken<ReadonlyArray<ControlValueAccessor>> = NG_VALUE_ACCESSOR

useExisting

useExisting: Type<any> = forwardRef(() => SfInputComponent)

Const DEFAULT_TREE_FIELDS

DEFAULT_TREE_FIELDS: object

ID

ID: string = "Id"

IS_EXPANDED

IS_EXPANDED: string = "expanded"

Const SANITIZER_TYPES

SANITIZER_TYPES: object

HTML

HTML: string = "html"

RESOURCE_URL

RESOURCE_URL: string = "resourceUrl"

SCRIPT

SCRIPT: string = "script"

STYLE

STYLE: string = "style"

URL

URL: string = "url"

Const SCROLL_DISTANCE

SCROLL_DISTANCE: object

END

END: number = 1

START

START: number = 0

Const SF_DOCUMENT_PROVIDER

SF_DOCUMENT_PROVIDER: object

provide

provide: InjectionToken<unknown> = SF_DOCUMENT_TOKEN

useFactory

useFactory: provideDocumentFactory = provideDocumentFactory

Const SF_WINDOW_PROVIDER

SF_WINDOW_PROVIDER: object

provide

provide: InjectionToken<unknown> = SF_WINDOW_TOKEN

useFactory

useFactory: sfGetWindowFactory = sfGetWindowFactory

Const markupTypes

markupTypes: object

chunkPresentation

chunkPresentation: ChunkPresentation = ChunkPresentation

sectionTypes

sectionTypes: SectionTypes = SectionTypes

Const stringConstants

stringConstants: object

AMPERSAND

AMPERSAND: string = "&"

ASTERISK

ASTERISK: string = "*"

BACKWARD_SLASH

BACKWARD_SLASH: string = "\"

COLON

COLON: string = ":"

COMMA

COMMA: string = ","

DASH

DASH: string = "-"

DEFAULT_GUID

DEFAULT_GUID: string = "00000000-0000-0000-0000-000000000000"

DOT

DOT: string = "."

ELLIPSIS

ELLIPSIS: string = "..."

EMPTY_STRING

EMPTY_STRING: string = ""

FORWARD_SLASH

FORWARD_SLASH: string = "/"

GREATER_THAN

GREATER_THAN: string = ">"

HASH

HASH: string = "#"

INTERVAL

INTERVAL: string = " "

NEW_LINE

NEW_LINE: string = ""

OPENING_BRACKET

OPENING_BRACKET: string = "("

OPENING_SQUARE_BRACKET

OPENING_SQUARE_BRACKET: string = "["

QUESTION_MARK

QUESTION_MARK: string = "?"

QUOTE

QUOTE: string = """

TYPE_UNDEFINED

TYPE_UNDEFINED: string = "undefined"

URLS

URLS: string = "Urls"

Generated using TypeDoc