uworld-flashcards

1.0.1 • Public • Published

Flash Cards

This project was generated with Angular CLI version 9.1.7.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

To test the library changes before deploying to production, follow the below steps:
Goto to the dist folder of the library and run

npm link

Install the library from dist folder, instead of npm server for local integeration.

Usage

Install through npm:

npm install --save @uworld/flashcards

Import in your app module:

import { UworldFlashcardsModule } from '@uworld/flashcards';`

@NgModule({
    declarations: [
    ],
    imports: [
        CommonModule,
        UworldFlashcardsModule
    ],
    bootstrap: [],
    providers: []
})
export class AppModule { }

Component to view list of decks and flashcards with search and filters

<uworld-browsemode
          [decks]="decks"
          [subjectList]="subjectList"
          [systemList]="systemList"
          (_getFlashcards)="getFlashcards($event)"
          (_searchFlashcards)="searchFlashcards($event)"
          (_updateDeck)="updateDeck($event)"
          (_deleteDeck)="deleteDeck($event)"
          (_deleteFlashcards)="deleteFlashcards($event)"
          (_undoDeleteOrRestoreFlashcards)="undoDeleteOrRestoreFlashcards($event)"
          (_restoreFlashcards)="restoreFlashcards($event)"
          (_moveFlashcards)="moveFlashcards($event)"
          (_undoMoveFlashcards)="undoMoveFlashcards($event)"
          (_openFlashcard)="openFlashcard($event)">
</uworld-browsemode>

Component for study mode

<uworld-studymode
                  [decks]="decks"
                  (_getStudyDecks)="getStudyDecks()"
                  (_getStudyDeckFlashCards)="getStudyDeckFlashCards($event)"
                  (_openFlashcard)="openFlashcard($event)">
</uworld-studymode>

Component to open a flashcard for review, edit, add and study mode operations

<uworld-cardview
                 [viewMode]="viewMode"
                 [studyMode]="studyMode"
                 [flashCard]="flashCard"
                 [cardIndex]="cardIndex"
                 [selectedDeck]="selectedDeck"                 
                 [dialogMaximized]="dialogMaximized"
                 (_insertFlashcard)="insertFlashcard($event)"
                 (_deleteFlashcard)="deleteFlashcard($event)"
                 (_restoreFlashcard)="restoreFlashcard($event)"
                 (_updateMarkFlashcard)="updateMarkFlashcard($event)"
                 (_updateFlashcard)="updateFlashcard($event)"
                 (_insertDeck)="insertDeck($event)"                 
                 (_saveStudyFlashcard)="saveStudyFlashcard($event)"
                 (_buryStudyFlashcard)="buryStudyFlashcard($event)"
                 (_suspendStudyFlashcard)="suspendStudyFlashcard($event)"
                 (_rescheduleStudyFlashcard)="rescheduleStudyFlashcard($event)"
                 (_maximize)="maximize()"
                 (_restore)="restore()"
                 (_close)="close()">
</uworld-cardview>

Further information refer to: https://uworld.atlassian.net/wiki/spaces/UW/pages/557482001/Library+Implementation

Readme

Keywords

none

Package Sidebar

Install

npm i uworld-flashcards

Weekly Downloads

1

Version

1.0.1

License

none

Unpacked Size

615 kB

Total Files

80

Last publish

Collaborators

  • nchennuboyina