feat(blog): tooltip for difficulty level (#298)

majahendzel-va · web-flow · commit c70bb79e7d48 · 2024-08-29T12:32:37.000+02:00
diff --git a/apps/blog/src/assets/i18n/en.json b/apps/blog/src/assets/i18n/en.json
@@ -91,7 +91,10 @@
   "difficulty": {
     "beginner": "Beginner",
     "intermediate": "Intermediate",
-    "advanced": "Advanced"
+    "advanced": "Advanced",
+    "tooltipBeginner": "Fundamental concepts, basic syntax, and simple projects.",
+    "tooltipIntermediate": "More complex features, intermediate concepts, performance, and best practices.",
+    "tooltipAdvanced": "Advanced topics, architecture, scalability, and professional development practices."
   },
   "tableOfContents": {
     "title": "Table of Contents"
diff --git a/apps/blog/src/assets/i18n/pl.json b/apps/blog/src/assets/i18n/pl.json
@@ -94,7 +94,10 @@
   "difficulty": {
     "beginner": "Początkujący",
     "intermediate": "Średnio zaawansowany",
-    "advanced": "Zaawansowany"
+    "advanced": "Zaawansowany",
+    "tooltipBeginner": "Podstawowe pojęcia, podstawowa składnia oraz proste projekty.",
+    "tooltipIntermediate": "Bardziej zaawansowane funkcje, performance oraz najlepsze praktyki.",
+    "tooltipAdvanced": "Jeżeli jest potrzebna jeszcze jakaś informacja czy design, proszę o znak"
   },
   "tableOfContents": {
     "title": "Spis treści"
diff --git a/apps/blog/src/styles.scss b/apps/blog/src/styles.scss
@@ -1,2 +1,4 @@
 @use '@angular/cdk';
 @include cdk.a11y-visually-hidden();
+
+@import '@angular/cdk/overlay-prebuilt.css';
diff --git a/libs/blog/shared/ui-difficulty/src/lib/difficulty-level.pipe.ts b/libs/blog/shared/ui-difficulty/src/lib/difficulty-level.pipe.ts
@@ -0,0 +1,35 @@
+import { inject, Pipe, PipeTransform } from '@angular/core';
+import { TranslocoService } from '@jsverse/transloco';
+import { map, Observable } from 'rxjs';
+
+@Pipe({
+  name: 'difficultyLevelTooltip',
+  standalone: true,
+})
+export class DifficultyLevelPipe implements PipeTransform {
+  private readonly _translocoService = inject(TranslocoService);
+  transform(difficultyLevel: number): Observable<string> {
+    return this._translocoService.langChanges$.pipe(
+      map(() => {
+        switch (difficultyLevel) {
+          case 0:
+            return this._translocoService.translate(
+              'difficulty.tooltipBeginner',
+            );
+          case 1:
+            return this._translocoService.translate(
+              'difficulty.tooltipIntermediate',
+            );
+          case 2:
+            return this._translocoService.translate(
+              'difficulty.tooltipAdvanced',
+            );
+          default:
+            return this._translocoService.translate(
+              'difficulty.tooltipIntermediate',
+            );
+        }
+      }),
+    );
+  }
+}
diff --git a/libs/blog/shared/ui-difficulty/src/lib/ui-difficulty.component.ts b/libs/blog/shared/ui-difficulty/src/lib/ui-difficulty.component.ts
@@ -1,4 +1,4 @@
-import { NgClass } from '@angular/common';
+import { AsyncPipe, NgClass } from '@angular/common';
 import {
   ChangeDetectionStrategy,
   Component,
@@ -7,14 +7,20 @@ import {
 } from '@angular/core';
 import { TranslocoDirective } from '@jsverse/transloco';
 
+import { TooltipDirective } from '@angular-love/ui-tooltip';
+
+import { DifficultyLevelPipe } from './difficulty-level.pipe';
+
 export type UiDifficulty = 'beginner' | 'intermediate' | 'advanced';
 
 @Component({
   selector: 'al-difficulty',
   standalone: true,
   template: `
     <div
+      alTooltip
       class="text-al-foreground/90 flex items-center overflow-hidden text-sm"
+      [tooltipText]="difficultyLevel() | difficultyLevelTooltip | async"
     >
       <!-- Left Block -->
       <div
@@ -78,7 +84,13 @@ export type UiDifficulty = 'beginner' | 'intermediate' | 'advanced';
     </div>
   `,
   changeDetection: ChangeDetectionStrategy.OnPush,
-  imports: [NgClass, TranslocoDirective],
+  imports: [
+    NgClass,
+    TranslocoDirective,
+    TooltipDirective,
+    DifficultyLevelPipe,
+    AsyncPipe,
+  ],
 })
 export class UiDifficultyComponent {
   readonly difficulty = input.required<UiDifficulty>();
diff --git a/libs/blog/shared/ui-tooltip/.eslintrc.json b/libs/blog/shared/ui-tooltip/.eslintrc.json
@@ -0,0 +1,36 @@
+{
+  "extends": ["../../../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts"],
+      "extends": [
+        "plugin:@nx/angular",
+        "plugin:@angular-eslint/template/process-inline-templates"
+      ],
+      "rules": {
+        "@angular-eslint/directive-selector": [
+          "error",
+          {
+            "type": "attribute",
+            "prefix": "al",
+            "style": "camelCase"
+          }
+        ],
+        "@angular-eslint/component-selector": [
+          "error",
+          {
+            "type": "element",
+            "prefix": "al",
+            "style": "kebab-case"
+          }
+        ]
+      }
+    },
+    {
+      "files": ["*.html"],
+      "extends": ["plugin:@nx/angular-template"],
+      "rules": {}
+    }
+  ]
+}
diff --git a/libs/blog/shared/ui-tooltip/README.md b/libs/blog/shared/ui-tooltip/README.md
@@ -0,0 +1,7 @@
+# ui-tooltip
+
+This library was generated with [Nx](https://nx.dev).
+
+## Running unit tests
+
+Run `nx test ui-tooltip` to execute the unit tests.
diff --git a/libs/blog/shared/ui-tooltip/jest.config.ts b/libs/blog/shared/ui-tooltip/jest.config.ts
@@ -0,0 +1,22 @@
+/* eslint-disable */
+export default {
+  displayName: 'ui-tooltip',
+  preset: '../../../../jest.preset.js',
+  setupFilesAfterEnv: ['<rootDir>/src/test-setup.ts'],
+  coverageDirectory: '../../../../coverage/libs/blog/shared/ui-tooltip',
+  transform: {
+    '^.+\\.(ts|mjs|js|html)$': [
+      'jest-preset-angular',
+      {
+        tsconfig: '<rootDir>/tsconfig.spec.json',
+        stringifyContentPathRegex: '\\.(html|svg)$',
+      },
+    ],
+  },
+  transformIgnorePatterns: ['node_modules/(?!.*\\.mjs$)'],
+  snapshotSerializers: [
+    'jest-preset-angular/build/serializers/no-ng-attributes',
+    'jest-preset-angular/build/serializers/ng-snapshot',
+    'jest-preset-angular/build/serializers/html-comment',
+  ],
+};
diff --git a/libs/blog/shared/ui-tooltip/project.json b/libs/blog/shared/ui-tooltip/project.json
@@ -0,0 +1,20 @@
+{
+  "name": "ui-tooltip",
+  "$schema": "../../../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "libs/blog/shared/ui-tooltip/src",
+  "prefix": "al",
+  "projectType": "library",
+  "tags": ["scope:client", "type:ui"],
+  "targets": {
+    "test": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "options": {
+        "jestConfig": "libs/blog/shared/ui-tooltip/jest.config.ts"
+      }
+    },
+    "lint": {
+      "executor": "@nx/eslint:lint"
+    }
+  }
+}
diff --git a/libs/blog/shared/ui-tooltip/src/index.ts b/libs/blog/shared/ui-tooltip/src/index.ts
@@ -0,0 +1,2 @@
+export * from './lib/ui-tooltip/ui-tooltip.component';
+export * from './lib/ui-tooltip/tooltip.directive';
diff --git a/libs/blog/shared/ui-tooltip/src/lib/ui-tooltip/tooltip.directive.ts b/libs/blog/shared/ui-tooltip/src/lib/ui-tooltip/tooltip.directive.ts
@@ -0,0 +1,72 @@
+import { Overlay, OverlayRef, PositionStrategy } from '@angular/cdk/overlay';
+import { ComponentPortal } from '@angular/cdk/portal';
+import {
+  ComponentRef,
+  Directive,
+  ElementRef,
+  HostListener,
+  inject,
+  input,
+  OnDestroy,
+} from '@angular/core';
+
+import { UiTooltipComponent } from './ui-tooltip.component';
+
+@Directive({
+  selector: '[alTooltip]',
+  standalone: true,
+})
+export class TooltipDirective implements OnDestroy {
+  tooltipText = input.required<string | null>();
+
+  private _overlayRef: OverlayRef | null = null;
+
+  private readonly _element = inject(ElementRef<HTMLElement>);
+  private readonly _overlay = inject(Overlay);
+
+  @HostListener('mouseenter')
+  showTooltip(): void {
+    if (this._overlayRef?.hasAttached() === true) {
+      return;
+    }
+
+    this._attachTooltip();
+  }
+
+  @HostListener('mouseleave')
+  hideTooltip(): void {
+    if (this._overlayRef?.hasAttached() === true) {
+      this._overlayRef?.detach();
+    }
+  }
+
+  ngOnDestroy(): void {
+    this._overlayRef?.dispose();
+  }
+
+  private _attachTooltip(): void {
+    if (this._overlayRef === null) {
+      this._overlayRef = this._overlay.create({
+        positionStrategy: this._getPositionStrategy(),
+      });
+    }
+    const tooltipRef: ComponentRef<UiTooltipComponent> =
+      this._overlayRef.attach(new ComponentPortal(UiTooltipComponent));
+    tooltipRef.instance.tooltipText.set(this.tooltipText()!);
+  }
+
+  private _getPositionStrategy(): PositionStrategy {
+    return this._overlay
+      .position()
+      .flexibleConnectedTo(this._element)
+      .withPositions([
+        {
+          originX: 'center',
+          originY: 'bottom',
+          overlayX: 'center',
+          overlayY: 'top',
+          panelClass: 'bottom',
+        },
+      ]);
+  }
+}
diff --git a/libs/blog/shared/ui-tooltip/src/lib/ui-tooltip/ui-tooltip.component.ts b/libs/blog/shared/ui-tooltip/src/lib/ui-tooltip/ui-tooltip.component.ts
@@ -0,0 +1,20 @@
+import { NgClass } from '@angular/common';
+import { ChangeDetectionStrategy, Component, signal } from '@angular/core';
+
+@Component({
+  selector: 'al-ui-tooltip',
+  standalone: true,
+  template: `
+    <div
+      class="box-border max-w-[13rem] rounded-[0.25rem] bg-[#2e2f3a] p-[0.3rem] text-sm text-white"
+      [ngClass]="{ 'mt-2': 'bottom' }"
+    >
+      {{ tooltipText() }}
+    </div>
+  `,
+  changeDetection: ChangeDetectionStrategy.OnPush,
+  imports: [NgClass],
+})
+export class UiTooltipComponent {
+  tooltipText = signal<string | undefined>('');
+}
diff --git a/libs/blog/shared/ui-tooltip/src/test-setup.ts b/libs/blog/shared/ui-tooltip/src/test-setup.ts
@@ -0,0 +1,9 @@
+import 'jest-preset-angular/setup-jest';
+
+// @ts-expect-error https://thymikee.github.io/jest-preset-angular/docs/getting-started/test-environment
+globalThis.ngJest = {
+  testEnvironmentOptions: {
+    errorOnUnknownElements: true,
+    errorOnUnknownProperties: true,
+  },
+};
diff --git a/libs/blog/shared/ui-tooltip/tsconfig.json b/libs/blog/shared/ui-tooltip/tsconfig.json
@@ -0,0 +1,28 @@
+{
+  "compilerOptions": {
+    "target": "es2022",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ],
+  "extends": "../../../../tsconfig.base.json",
+  "angularCompilerOptions": {
+    "enableI18nLegacyMessageIdFormat": false,
+    "strictInjectionParameters": true,
+    "strictInputAccessModifiers": true,
+    "strictTemplates": true
+  }
+}
diff --git a/libs/blog/shared/ui-tooltip/tsconfig.lib.json b/libs/blog/shared/ui-tooltip/tsconfig.lib.json
@@ -0,0 +1,17 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../../../dist/out-tsc",
+    "declaration": true,
+    "declarationMap": true,
+    "inlineSources": true,
+    "types": []
+  },
+  "exclude": [
+    "src/**/*.spec.ts",
+    "src/test-setup.ts",
+    "jest.config.ts",
+    "src/**/*.test.ts"
+  ],
+  "include": ["src/**/*.ts"]
+}
diff --git a/libs/blog/shared/ui-tooltip/tsconfig.spec.json b/libs/blog/shared/ui-tooltip/tsconfig.spec.json
@@ -0,0 +1,16 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../../../dist/out-tsc",
+    "module": "commonjs",
+    "target": "es2016",
+    "types": ["jest", "node"]
+  },
+  "files": ["src/test-setup.ts"],
+  "include": [
+    "jest.config.ts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.d.ts"
+  ]
+}
diff --git a/tsconfig.base.json b/tsconfig.base.json
@@ -195,6 +195,7 @@
         "libs/shared/utils-signal-store/src/index.ts"
       ],
       "@angular-love/storybook": ["libs/shared/storybook/src/index.ts"],
+      "@angular-love/ui-tooltip": ["libs/blog/shared/ui-tooltip/src/index.ts"],
       "@angular-love/util-wp": ["libs/blog-bff/shared/util-wp/src/index.ts"],
       "@angular-love/utils": ["libs/utils/src/index.ts"]
     }

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+export * from './lib/ui-tooltip/ui-tooltip.component';`
	`2`	`+export * from './lib/ui-tooltip/tooltip.directive';`