@progress/sitefinity-component-framework
v13.0.0
Published
This package contains reusable Angular elements, such as components, directive, services and helpers which can be used in Angular applications.
Readme
Sitefinity Component Framework
This package contains reusable Angular elements, such as components, directive, services and helpers which can be used in Angular applications.
Usage
Import the modules of the components you would like to use.
Application imports must use the public @progress/sitefinity-component-framework entry point.
API Documentation
https://component-framework-docs.sitefinity.site/
Presentation components
SfNoPreviewViewModuleexportssf-no-preview-view. Supplytitle,pagesLinkText,firstStep,lastStep,pagesUrl, andmessages(descriptionandsecondStep). Null messages hide the instructions.pagesLinkClickedreports activation without replacing native link navigation.SfNoItemsFoundModuleexportssf-no-items-found. Its existing inputs control the title, message, fallback item label, icon and appearance. Messages are escaped by default;messageAllowHtmlopts into Angular-sanitized HTML.SfActionProgressOverlayViewModuleexportssf-action-progress-overlay-view. Booleanvisiblecontrols rendering;separateToolbarselects separate content and toolbar overlays instead of a single full-viewport overlay. Applications own progress subscriptions and layout selection. The view has no services or business logic.
Additional presentation-only views:
| Module | Selector | Presentation contract |
|---|---|---|
| SfErrorDisplayViewModule | sf-error-display-view | status, result, errorLabel, iconName, iconLook, showDetails |
| SfToolbarViewModule | sf-toolbar-view | heading, superScript, showBadge, badgeText, badgeTooltip |
| SfGridNavigationViewModule | sf-grid-navigation-view | visible, title; separate clickActivated and enterActivated outputs |
| SfMediaReorderDropViewModule | sf-media-reorder-drop-view | sourceUrl, altText, isWide, icon, topPx, leftPx, heightPx |
| SfBasicNotificationViewModule | sf-basic-notification-view | message, showMessage, showAction, actionLabel, busy; actionClicked output |
| SfShowImprovementViewModule | sf-show-improvement-view | formattedPercentage, comparisonPeriodCopy, isPositive, show |
| SfFileInfoViewModule | sf-file-info-view | multiple, dimensions, hasSize, sizeText, extensionText, tooltipExtension |
| SfSidebarButtonsViewModule | sf-sidebar-buttons-view | Plain SidebarButtonPresentation[] in buttons; buttonActivated emits the original index |
| SfErrorPageViewModule | sf-error-page-view | iconName, heading, descriptionLines, actionLabel, brandingText; actionActivated output |
| SfDateAndUserViewModule | sf-date-and-user-view | dateText, tooltipText, userText, attributionLabel, testId (renders nothing without dateText) |
| SfMultiValueTextViewModule | sf-multi-value-text-view | value, valueCss, additionalValues, additionalValuesCss |
| SfHeadingStatusViewModule | sf-heading-status-view | mainStatus, secondaryStatus, isEditMode, lockedText, firstDate/secondDate (SfHeadingStatusDate) |
Sidebar descriptors contain title, look, icon, counter, customFont, active, and locked.
Applications resolve notification streams, active configuration, permissions, and dispatches.
Notification messages retain Angular HTML sanitization; application-specific sanitization stays in the wrapper.
File sizes, dimensions, reporting-period copy, and percentage strings arrive already formatted.
These components do not depend on application services. Applications own URL construction, metadata lookup and
business decisions. Their presentation tests run in the component-framework target without AppModule or SfTestBed.
From admin-app, run only these tests:
$env:karmaParallel = "false"
node .\node_modules\@angular\cli\bin\ng test sitefinity-component-framework --watch=false `
--include="**\*-view\*.spec.ts" --include="**\no-items-found\*.spec.ts"Styles
All Sitefinity Component Framework styles can be found in styles/dist/sitefinity/css/main.min.css.
