Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(VLEComponent): Convert to standalone #1951

Merged
merged 1 commit into from
Sep 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 3 additions & 28 deletions src/app/student/vle/student-vle.module.ts
Original file line number Diff line number Diff line change
@@ -1,19 +1,14 @@
import '../../../assets/wise5/lib/jquery/jquery-global';
import { CommonModule } from '@angular/common';
import { NgModule } from '@angular/core';
import { MatButtonModule } from '@angular/material/button';
import { MatDialogModule } from '@angular/material/dialog';
import { MatListModule } from '@angular/material/list';
import { ComponentStudentModule } from '../../../assets/wise5/components/component/component-student.module';
import { GenerateImageDialogComponent } from '../../../assets/wise5/directives/generate-image-dialog/generate-image-dialog.component';
import { SafeUrl } from '../../../assets/wise5/directives/safeUrl/safe-url.pipe';
import { SimpleDialogModule } from '../../../assets/wise5/directives/simple-dialog.module';
import { SummaryDisplayModule } from '../../../assets/wise5/directives/summary-display/summary-display.module';
import { InitializeVLEService } from '../../../assets/wise5/services/initializeVLEService';
import { ProjectService } from '../../../assets/wise5/services/projectService';
import { StudentDataService } from '../../../assets/wise5/services/studentDataService';
import { NavigationComponent } from '../../../assets/wise5/themes/default/navigation/navigation.component';
import { StepToolsComponent } from '../../../assets/wise5/themes/default/themeComponents/stepTools/step-tools.component';
import { StudentAssetsDialogModule } from '../../../assets/wise5/vle/studentAsset/student-assets-dialog/student-assets-dialog.module';
import { VLEComponent } from '../../../assets/wise5/vle/vle.component';
import { VLEProjectService } from '../../../assets/wise5/vle/vleProjectService';
Expand All @@ -26,41 +21,22 @@ import { PauseScreenService } from '../../../assets/wise5/services/pauseScreenSe
import { StudentNotificationService } from '../../../assets/wise5/services/studentNotificationService';
import { NotificationService } from '../../../assets/wise5/services/notificationService';
import { VLEParentComponent } from '../../../assets/wise5/vle/vle-parent/vle-parent.component';
import { RunEndedAndLockedMessageComponent } from '../../../assets/wise5/vle/run-ended-and-locked-message/run-ended-and-locked-message.component';
import { NodeNavigationComponent } from '../../../assets/wise5/directives/node-navigation/node-navigation.component';
import { GroupTabsComponent } from '../../../assets/wise5/directives/group-tabs/group-tabs.component';
import { StudentPeerGroupService } from '../../../assets/wise5/services/studentPeerGroupService';
import { PeerGroupService } from '../../../assets/wise5/services/peerGroupService';
import { TopBarComponent } from '../top-bar/top-bar.component';
import { NodeStatusIconComponent } from '../../../assets/wise5/themes/default/themeComponents/nodeStatusIcon/node-status-icon.component';
import { NodeComponent } from '../../../assets/wise5/vle/node/node.component';

@NgModule({
declarations: [
ChooseBranchPathDialogComponent,
GenerateImageDialogComponent,
SafeUrl,
VLEComponent,
VLEParentComponent
],
declarations: [ChooseBranchPathDialogComponent, GenerateImageDialogComponent, VLEParentComponent],
imports: [
CommonModule,
ComponentStudentModule,
GroupTabsComponent,
MatDialogModule,
NavigationComponent,
NodeComponent,
NodeNavigationComponent,
NodeStatusIconComponent,
RunEndedAndLockedMessageComponent,
SimpleDialogModule,
StepToolsComponent,
StudentAssetsDialogModule,
StudentComponentModule,
StudentTeacherCommonModule,
StudentVLERoutingModule,
SummaryDisplayModule,
TopBarComponent
VLEComponent
],
providers: [
InitializeVLEService,
Expand All @@ -71,7 +47,6 @@ import { NodeComponent } from '../../../assets/wise5/vle/node/node.component';
{ provide: ProjectService, useExisting: VLEProjectService },
StudentNotificationService,
VLEProjectService
],
exports: [CommonModule, MatButtonModule, MatDialogModule, MatListModule]
]
})
export class StudentVLEModule {}
3 changes: 2 additions & 1 deletion src/assets/wise5/directives/safeUrl/safe-url.pipe.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ import { Pipe, PipeTransform } from '@angular/core';
import { DomSanitizer } from '@angular/platform-browser';

@Pipe({
name: 'safeUrl'
name: 'safeUrl',
standalone: true
})
export class SafeUrl implements PipeTransform {
constructor(private sanitizer: DomSanitizer) {}
Expand Down
1 change: 0 additions & 1 deletion src/assets/wise5/vle/vle-parent/vle-parent.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import { StudentDataService } from '../../services/studentDataService';
import { VLEProjectService } from '../vleProjectService';

@Component({
selector: 'vle-parent',
templateUrl: './vle-parent.component.html'
})
export class VLEParentComponent implements OnInit {
Expand Down
52 changes: 32 additions & 20 deletions src/assets/wise5/vle/vle.component.html
Original file line number Diff line number Diff line change
@@ -1,37 +1,47 @@
<link rel="stylesheet" href="/assets/wise5/themes/default/style/angular-material.css" />
<link rel="stylesheet" href="/assets/wise5/themes/default/style/vle.css" />
<link rel="stylesheet" [href]="projectStylePath | safeUrl" />
<mat-drawer-container [hasBackdrop]="false" *ngIf="initialized">
<mat-drawer #drawer mode="over" position="end" (keydown.escape)="closeNotes()">
<notebook-notes [config]="notebookConfig" />
</mat-drawer>
<mat-drawer-content>
<top-bar [projectName]="project.metadata.title"></top-bar>
<ng-container *ngTemplateOutlet="vleTemplate"></ng-container>
@if (reportEnabled) {
<notebook-report
[ngClass]="{ 'notes-visible': notesVisible, 'report-full': reportFullscreen }"
[config]="notebookConfig"
/>
}
<notebook-launcher *ngIf="notesEnabled && !notesVisible" [notebookConfig]="notebookConfig" />
</mat-drawer-content>
</mat-drawer-container>
@if (initialized) {
<mat-drawer-container [hasBackdrop]="false">
<mat-drawer #drawer mode="over" position="end" (keydown.escape)="closeNotes()">
<notebook-notes [config]="notebookConfig" />
</mat-drawer>
<mat-drawer-content>
<top-bar [projectName]="project.metadata.title" />
<ng-container *ngTemplateOutlet="vleTemplate"></ng-container>
@if (reportEnabled) {
<notebook-report
[ngClass]="{ 'notes-visible': notesVisible, 'report-full': reportFullscreen }"
[config]="notebookConfig"
/>
}
@if (notesEnabled && !notesVisible) {
<notebook-launcher [notebookConfig]="notebookConfig" />
}
</mat-drawer-content>
</mat-drawer-container>
}

<div id="wise-link-communicator" class="wise-link-communicator"></div>

<ng-template #defaultVLETemplate>
<step-tools *ngIf="layoutState === 'node'" class="control-bg-bg mat-elevation-z1" />
@if (layoutState === 'node') {
<step-tools class="control-bg-bg mat-elevation-z1" />
}
<div
id="content"
class="vle-content"
[ngClass]="{ 'nav-view': layoutState === 'nav', 'node-view': layoutState === 'node' }"
>
<run-ended-and-locked-message *ngIf="runEndedAndLocked" class="notice" />
@if (runEndedAndLocked) {
<run-ended-and-locked-message class="notice" />
}
@if (layoutState === 'node') {
<node class="top" [node]="currentNode" />
}
<navigation *ngIf="layoutState === 'nav'" class="top"></navigation>
@if (layoutState === 'nav') {
<navigation class="top" />
}
</div>
</ng-template>

Expand All @@ -43,7 +53,9 @@
>
<group-tabs />
<div class="tab-content">
<run-ended-and-locked-message *ngIf="runEndedAndLocked" />
@if (runEndedAndLocked) {
<run-ended-and-locked-message />
}
@if (layoutState === 'node') {
<node class="node-tabbed top" [node]="currentNode" />
}
Expand Down
45 changes: 2 additions & 43 deletions src/assets/wise5/vle/vle.component.spec.ts
Original file line number Diff line number Diff line change
@@ -1,33 +1,14 @@
import { ComponentFixture, TestBed } from '@angular/core/testing';
import { MatDialogModule } from '@angular/material/dialog';
import { ConfigService } from '../services/configService';
import { NotebookService } from '../services/notebookService';
import { VLEProjectService } from './vleProjectService';
import { VLEComponent } from './vle.component';
import { StudentDataService } from '../services/studentDataService';
import { provideHttpClientTesting } from '@angular/common/http/testing';
import { MatSidenavModule } from '@angular/material/sidenav';
import { TopBarComponent } from '../../../app/student/top-bar/top-bar.component';
import { NodeComponent } from './node/node.component';
import { NotebookNotesComponent } from '../../../app/notebook/notebook-notes/notebook-notes.component';
import { BrowserAnimationsModule } from '@angular/platform-browser/animations';
import { MatProgressSpinnerModule } from '@angular/material/progress-spinner';
import { MatIconModule } from '@angular/material/icon';
import { MatDividerModule } from '@angular/material/divider';
import { MatToolbarModule } from '@angular/material/toolbar';
import { MatMenuModule } from '@angular/material/menu';
import { MatBadgeModule } from '@angular/material/badge';
import { NavigationComponent } from '../themes/default/navigation/navigation.component';
import { StepToolsComponent } from '../themes/default/themeComponents/stepTools/step-tools.component';
import { MatSelectModule } from '@angular/material/select';
import { NodeStatusIconComponent } from '../themes/default/themeComponents/nodeStatusIcon/node-status-icon.component';
import { NodeIconComponent } from './node-icon/node-icon.component';
import { FormsModule } from '@angular/forms';
import { InitializeVLEService } from '../services/initializeVLEService';
import { StudentTeacherCommonServicesModule } from '../../../app/student-teacher-common-services.module';
import { PauseScreenService } from '../services/pauseScreenService';
import { StudentNotificationService } from '../services/studentNotificationService';
import { SafeUrl } from '../../../assets/wise5/directives/safeUrl/safe-url.pipe';
import { provideRouter } from '@angular/router';
import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http';

Expand All @@ -39,36 +20,14 @@ let saveVLEEventSpy: jasmine.Spy;
describe('VLEComponent', () => {
beforeEach(async () => {
await TestBed.configureTestingModule({
declarations: [SafeUrl, VLEComponent],
imports: [
BrowserAnimationsModule,
FormsModule,
MatBadgeModule,
MatDialogModule,
MatDividerModule,
MatIconModule,
MatMenuModule,
MatProgressSpinnerModule,
MatToolbarModule,
MatSelectModule,
MatSidenavModule,
NavigationComponent,
NodeComponent,
NodeIconComponent,
NodeStatusIconComponent,
NotebookNotesComponent,
StepToolsComponent,
StudentTeacherCommonServicesModule,
TopBarComponent
],
imports: [BrowserAnimationsModule, VLEComponent, StudentTeacherCommonServicesModule],
providers: [
InitializeVLEService,
PauseScreenService,
provideRouter([]),
StudentNotificationService,
VLEProjectService,
provideHttpClient(withInterceptorsFromDi()),
provideHttpClientTesting()
provideHttpClient(withInterceptorsFromDi())
]
}).compileComponents();
});
Expand Down
64 changes: 45 additions & 19 deletions src/assets/wise5/vle/vle.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,31 +16,58 @@ import { convertToPNGFile } from '../common/canvas/canvas';
import { NodeStatusService } from '../services/nodeStatusService';
import { Node } from '../common/Node';
import { SafeResourceUrl } from '@angular/platform-browser';
import { CommonModule } from '@angular/common';
import { NotebookNotesComponent } from '../../../app/notebook/notebook-notes/notebook-notes.component';
import { MatSidenavModule } from '@angular/material/sidenav';
import { SafeUrl } from '../directives/safeUrl/safe-url.pipe';
import { NodeNavigationComponent } from '../directives/node-navigation/node-navigation.component';
import { GroupTabsComponent } from '../directives/group-tabs/group-tabs.component';
import { TopBarComponent } from '../../../app/student/top-bar/top-bar.component';
import { NotebookReportComponent } from '../../../app/notebook/notebook-report/notebook-report.component';
import { NotebookLauncherComponent } from '../../../app/notebook/notebook-launcher/notebook-launcher.component';
import { StepToolsComponent } from '../themes/default/themeComponents/stepTools/step-tools.component';
import { RunEndedAndLockedMessageComponent } from './run-ended-and-locked-message/run-ended-and-locked-message.component';
import { NodeComponent } from './node/node.component';
import { NavigationComponent } from '../themes/default/navigation/navigation.component';

@Component({
imports: [
CommonModule,
GroupTabsComponent,
MatSidenavModule,
NavigationComponent,
NodeComponent,
NodeNavigationComponent,
NotebookLauncherComponent,
NotebookNotesComponent,
NotebookReportComponent,
RunEndedAndLockedMessageComponent,
SafeUrl,
StepToolsComponent,
TopBarComponent
],
selector: 'vle',
templateUrl: './vle.component.html',
styleUrls: ['./vle.component.scss']
standalone: true,
styleUrl: './vle.component.scss',
templateUrl: './vle.component.html'
})
export class VLEComponent implements AfterViewInit {
protected currentNode: Node;
@ViewChild('defaultVLETemplate') private defaultVLETemplate: TemplateRef<any>;
@ViewChild('drawer') public drawer: any;
protected initialized: boolean;
protected layoutState: string;
protected notebookConfig: any;
protected notesEnabled: boolean = false;
protected notesVisible: boolean = false;
protected project: any;
protected projectStylePath: SafeResourceUrl;
protected reportEnabled: boolean = false;
protected reportFullscreen: boolean = false;
protected runEndedAndLocked: boolean;
private subscriptions: Subscription = new Subscription();
@ViewChild('tabbedVLETemplate') private tabbedVLETemplate: TemplateRef<any>;

currentNode: Node;
initialized: boolean;
layoutState: string;
notebookConfig: any;
notesEnabled: boolean = false;
notesVisible: boolean = false;
project: any;
projectStylePath: SafeResourceUrl;
reportEnabled: boolean = false;
reportFullscreen: boolean = false;
rootNode: any;
runEndedAndLocked: boolean;
subscriptions: Subscription = new Subscription();
vleTemplate: TemplateRef<any>;
protected vleTemplate: TemplateRef<any>;

constructor(
private annotationService: AnnotationService,
Expand Down Expand Up @@ -73,7 +100,7 @@ export class VLEComponent implements AfterViewInit {
this.wiseLinkService.addWiseLinkClickedListener();
}

initRestOfVLE() {
private initRestOfVLE(): void {
this.setProject();
this.vleTemplate =
this.projectService.project.theme === 'tab'
Expand Down Expand Up @@ -122,7 +149,6 @@ export class VLEComponent implements AfterViewInit {

private setProject(): void {
this.project = this.projectService.getProject();
this.rootNode = this.projectService.rootNode;
this.setCurrentNode();
}

Expand Down
4 changes: 2 additions & 2 deletions src/messages.xlf
Original file line number Diff line number Diff line change
Expand Up @@ -10026,7 +10026,7 @@ Click &quot;Cancel&quot; to keep the invalid JSON open so you can fix it.</sourc
</context-group>
<context-group purpose="location">
<context context-type="sourcefile">src/assets/wise5/vle/vle.component.ts</context>
<context context-type="linenumber">168</context>
<context context-type="linenumber">194</context>
</context-group>
</trans-unit>
<trans-unit id="537022937435161177" datatype="html">
Expand All @@ -10041,7 +10041,7 @@ Click &quot;Cancel&quot; to keep the invalid JSON open so you can fix it.</sourc
</context-group>
<context-group purpose="location">
<context context-type="sourcefile">src/assets/wise5/vle/vle.component.ts</context>
<context context-type="linenumber">169</context>
<context context-type="linenumber">195</context>
</context-group>
</trans-unit>
<trans-unit id="3407061818321766940" datatype="html">
Expand Down
Loading