@project-sunbird/common-consumption

Common angular components for Sunbird consumption!

Contains common UI components powered by angular. These components are designed to be used in sunbird consumption platforms (mobile app, web portal, offline desktop app) to drive reusability, maintainability hence reducing the redundant development effort significantly.

Getting Started

For help getting started with a new Angular app, check out the Angular CLI.

For existing apps, follow these steps to begin using .

Step 1: Install the package

npm install @project-sunbird/common-consumption --save
npm install common-consumption-styles

Step 2: Include the common consumption styles in angular.json

"styles": [
    ...
    ...
    "./node_modules/common-consumption-styles/assets/_styles.scss"
]

Step 3: Import the modules and components

Import the NgModule for each component you want to use:

import { CommonConsumptionModule} from '@project-sunbird/common-consumption';

@NgModule({
    ...
    imports: [CommonConsumptionModule],
    ...
})

export class TestAppModule { }

Alternatively, you can create a separate NgModule that imports and then re-exports all of the Angular components that you will use in your application. By exporting them again, other modules can simply include your CustomSunbirdComponentsModule wherever components are needed, and automatically get all of the exported modules. A good place for importing/exporting the application-wide modules is the SharedModule.

import {CardsModule} from '@project-sunbird/common-consumption/card';

import {PopoverModule} from '@project-sunbird/common-consumption/popover';

@NgModule({
    ...
    imports: [CardsModule, PopoverModule],
    exports: [CardsModule, PopoverModule],
    ...
})

export class MyOwnCustomSunbirdComponentsModule { }

Available components

Feature	Notes	Selector
LibraryCard	Can be used in the library page for all consumption platforms	sb-library-card
CourseCard	Can be used in the courses page for all consumption platforms	sb-course-card
LibraryCardsGrid	Can be used in the courses page for all consumption platforms	sb-library-cards-grid
LibraryCardsStackComponent	Can be used in the courses page for all consumption platforms	sb-library-cards-stack
Confirmation Modal	Can be used in places where a popup is needed with user prompt	sb-confirmation-modal
LibraryFilters	Can be used in the library page for all consumption platforms.	sb-library-filters

LibraryCard

Can be used in the library page for all consumption platforms.

import { LibraryCardComponent } from '@project-sunbird/common-consumption/card/LibraryCardComponent'

Selector: sb-library-card

Exported as : LibraryCardComponent

Properties

Name	Description
@Input() content: IContent	Content Object
@Input() defaultImg: string	Default image path to show when there is image unavailable
Optional @Input() isMobile: boolean	Flag to distinguish mobile platform
Optional @Input() isOffline: boolean	Flag to handle offline scenarios
Optional @Input() offlineImg: string	Image path to show when the device is offline(Applicable when isOffline = true)

LibraryCardsGrid

Can be used in the library page for all consumption platforms targetting web platform

import { SbLibraryCardsGrid } form '@sunbird/components/SbLibraryCard`sGrid'

Selector: sb-library-cards-grid

Exported as: SbLibraryCardsGrid

Properties

Name	Description
@Input() title: boolean	Name that represents the section
@Input() contentList: collection	Collection of contents, where each content is a object from server API
Optional @Input() maxCardCount: Number	Number of cards to display the viewing area Default value is 3
Optional @Input() viewMoreButtonText: string	custom text to show in place of view all button, if there are more number of cards than "maxCardCount" then a button needs to be displayed. Default value is "View All"

Events

Name	Description
@Output() viewMoreClick	Emits this event when view all button is clicked
@Output() cardClick	Emits this event when card is clicked

LibraryCardsStackComponent

Can be used in the library page for mobile consumption

import { LibraryCardsStackComponent} form '@sunbird/components/LibraryCardsStackComponent'

Selector: sb-library-cards-stack

Exported as: LibraryCardsStackComponent

Properties

Name	Description
@Input() title: boolean	Name that represents the section
@Input() contentList: collection	Collection of contents, where each content is a object from server API
Optional @Input() maxCardCount: Number	Number of cards to display the viewing area Default value is 3
Optional @Input() viewMoreButtonText: string	custom text to show in place of view all button, if there are more number of cards than "maxCardCount" then a button needs to be displayed. Default value is "View All"
Optional @Input() isOffline: boolean	Flag to handle offline scenarios Default value is "False"

Events

Name	Description
@Output() viewMoreClick	Emits this event when view all button is clicked
@Output() cardClick	Emits this event when card is clicked

LibraryFilters

Can be used in the library page for all consumption platforms.

import { LibraryFiltersComponent } from '@Sunbird/components/library-filters'

Selector: sb-library-filters

Exported as : LibraryFiltersComponent

Properties

Name	Description
@Input() list: Array<ILibraryList>	Collection of text and active
@Input() layout: LibraryFiltersLayout	Pill Layout to show(Round, Square)

Events

Name	Description
@Output() getSelectedPill	Emmits this event when user clicks on the card