npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

sunbird-ed-discussions-ui-v8

v1.0.1

Published

Sunbird discussions ui library

Downloads

5

Readme

Step 1: Install the package

   npm install

Step 2: import CsModule from project-sunbird in root component

   import { CsModule } from '@project-sunbird/client-services'

Step 3: install and configure the common service library

Refer the common service library documentation https://github.com/Sunbird-Ed/sunbird-client-services

if (!CsModule.instance.isInitialised) { // Singleton initialised or not
   await CsModule.instance.init({
       core: {
           ...
           global: {
              ...
           },
           api: {
               host: 'https://domain.com', // default host
               authentication: {
                   // userToken: string; // optional
                   // bearerToken: string; // optional
               }
           }
       },
       services: {
            ...
            ...
            discussionServiceConfig: {
               apiPath: '/discussion',
            },
       }
   );
}

Step 4: import DiscussionUiModule from project-sunbird in app.module.ts

 import { DiscussionUiModule } from '@project-sunbird/discussions-ui-v8'
 import { ConfigService } from '/services/config.service'


 @NgModule({
    declarations: [],
    imports: [
        CommonModule,
        DiscussionUiModule.forRoot(ConfigService),
    ],
    exports: [DiscussionUiModule],
})

Step 5: Define the config service implementation which is used in above step


import { Injectable } from '@angular/core'
import { AbstractConfigService, IdiscussionConfig } from '@project-sunbird/discussions-ui-v8'

@Injectable({
 providedIn: 'root'
})
export class ConfigService extends AbstractConfigService {

 constructor() {
   super()
 }

 getConfig(key: any): IdiscussionConfig {
   return localStorage.getItem(key)
 }

}

Step 6: Add the below route in router module for loading the library in routing mode


 {
   path: 'discussion-forum',
   loadChildren: () => import('@project-sunbird/discussions-ui-v8').then(u => u.DiscussionUiModule),
 }

Step 7: Use the route to redirect to discussion-forum after setting the config in local storage


import { IdiscussionConfig } from '@project-sunbird/discussions-ui-v8'

  discussionConfig: IdiscussionConfig = {
   userName: 'nptest',
   categories: { result: ["2"] },
 }
 
 navigate() {
 localStorage.setItem('home', JSON.stringify(this.discussionConfig))
 this.router.navigate(['/discussion-forum'], { queryParams: { page: 'home' }, queryParamsHandling: "merge" })
 }

Step 8: Use the selector of the widget as below to use the widgets in desired components with input


  <sb-category-widget [config]="discussionConfig"></sb-category-widget>

Import the IdiscussionConfig interface from the library to know which data to pass.


import { IdiscussionConfig } from '@project-sunbird/discussions-ui-v8'

Available components

|Feature| Notes| Selector| |--|--|--| | [LibEntryComponent] | entry point for the library in routing mode| sb-lib-entry| | [SidePannelComponent] | used for loading the menu items and switching between them |sb-side-pannel| | [ DiscussCategoryComponent ] |used to load the list of categories available |sb-discuss-category| | [DiscussHomeComponent] | home component for categories | sb-discuss-home| [DiscussionDetailsComponent] | loads the category details |sb-discussion-details| | [DiscussTagsComponent] | displays all the tags available |sb-discuss-tags| | [MyDiscussionComponent] | displays the user data |sb-my-discussion| | [DiscussStartComponent] | used to start the discussion |sb-discuss-start|