Angular の抽象テキストコンテンツ-jsチュートリアル-php.cn

Angular の抽象テキストコンテンツ

PHPz

リリース： 2024-09-08 22:32:03

オリジナル

828 人が閲覧しました

Web サイトを開発している場合は、コンポーネントテンプレートに多くのテキストを記述する可能性があります。

Abstract text content in Angular

このようにテキストを書くことは、壊れたりバグがあるわけではありませんが、長期にわたるプロジェクトの維持にはかなり面倒です。これを改善するには、特定の機能のすべてのテキストを含むファイルを作成し、正しいキーをインポートすることでアプリ全体でそれを再利用できます。

このファイルは次のとおりです:

JSON ファイル
TypeScript ファイル

両方のアプローチの長所と短所について説明します。

I) JSON 翻訳ファイル

(1) JSONファイルを作成する

プロジェクトのルートディレクトリで、src/assets に移動し、新しいフォルダー (wording) と JSON ファイル (wording.json) を作成します。

? src 
|__ ? assets
|_____ ? wording
|_______ wording.json

ログイン後にコピー

翻訳を追加します:

{
  "APP": {
    "TITLE": "Movies App",
    "DESCRIPTION": "The best site for movies"
  },
  "COMMON": {
    "BUTTON": "Peek In"
  },
  "MOVIES": {
    "BATMAN": {
      "TITLE": "Batman",
      "SERIES": {
        "THE_DARK_KNIGHT": {
          "TITLE": "The Dark Knight Series",
          "MOVIES": {
            "BATMAN_BEGINS": {
              "TITLE": "Batman Begins",
              "DESCRIPTION": "Bruce learns the art of fighting to confront injustice."
            },
            "THE_DARK_KNIGHT": {
              "TITLE": "The Dark Knight",
              "DESCRIPTION": "Lorem Ipsum"
            },
            "THE_DARK_KNIGHT_RISES": {
              "TITLE": "The Dark Knight Rises",
              "DESCRIPTION": "Lorem Ipsum"
            }
          }
        }
      }

    }
  }
}

ログイン後にコピー

(2) TSConfigの更新

必要に応じて、resolveJsonModule: true を tsconfig.json コンパイラオプションに追加して、JSON ファイルを ECMAScript モジュールにインポートできるようにします。

{
  "compilerOptions": {
    "resolveJsonModule": true, // Add this line to tsconfig.json
  }
}

ログイン後にコピー

(3) JSONファイルを利用する

ファイルをコンポーネントに直接インポートします

// component file
import wording from '../../assets/wording/wording.json';

@Component({...}) 
export class HomeComponent implements OnInit {

  public pageText!: any;

  ngOnInit(): void {
    this.pageText = wording.MOVIES.BATMAN;
  }

}

ログイン後にコピー

または、すべての文言をグローバルにインポートするサービスを作成します:

// translations.service.ts

import { Injectable } from '@angular/core';
import { HttpClient } from '@angular/common/http';

@Injectable({
  providedIn: 'root'
})
export class TranslationsService {

  public wording!: any;

  constructor(private http: HttpClient) {
    this.setTranslations();
  }

  private setTranslations() {
    this.http.get('./assets/wording/wording.json').subscribe(data => {
      this.wording = data;
     });
  }

}

ログイン後にコピー

そして、サービスをコンポーネントに挿入します。

@Component({...}) 
export class HomeComponent implements OnInit {

  public pageText!: any;

  constructor(private readonly translationsService: TranslationsService) {}

  ngOnInit(): void {
    this.pageText = this.translationsService.wording.MOVIES.BATMAN;
  }

}

ログイン後にコピー

ただし、このアプローチの欠点は、テキストコンテンツに対するインテリセンスがないことです。

  <div class="movie-main-container">
    <span class="heading0">{{ pageText.TITLE }}</span>
    <!-- ..............No complaints here ? -->
    <div class="heading4">{{ pageText.HELLO_WORLD }}</div>
  </div>

ログイン後にコピー

これを解決するには、wording.json ファイル全体またはコンポーネントで使用している特定のオブジェクト (「バットマン」) の周りにカスタムタイプまたはインターフェイスを構築する必要があります。

II) TypeScript 翻訳ファイル

これを行うもう 1 つの方法は、JSON ファイルを破棄して、代わりに Typescript ファイルを作成することです。

(1)

src/app 内の任意の場所に新しい wording.ts ファイルを作成します

// wording.ts
const WORDING = {
  APP: {
    TITLE: 'Movies App',
    DESCRIPTION: 'The best site for movies',
  },
  COMMON: {
    BUTTON: 'Peek In',
  },
  MOVIES: {
    BATMAN: {
      TITLE: 'Batman',
      SERIES: {
        THE_DARK_KNIGHT: {
          TITLE: 'The Dark Knight Series',
          MOVIES: {
            BATMAN_BEGINS: {
              TITLE: 'Batman Begins',
              DESCRIPTION:
                'Bruce learns the art of fighting to confront injustice.',
            },
            THE_DARK_KNIGHT: {
              TITLE: 'The Dark Knight',
              DESCRIPTION: 'Lorem Ipsum',
            },
            THE_DARK_KNIGHT_RISES: {
              TITLE: 'The Dark Knight Rises',
              DESCRIPTION: 'Lorem Ipsum',
            },
          },
        },
      },
    },
  },
};

export default WORDING;

ログイン後にコピー

(2) このファイルを読み込むクラスを作成します。

任意のコンポーネントに新しい wordings.ts ファイルをインポートできます。ただし、私はこのファイルから読み取るカスタム (UseWording) クラスを作成することを好みます。

// use-wording.ts

import WORDING from './wording';

/**
 * Wrapper for translation wording
 */
export default class UseWording {

  get useWording() {
    return WORDING
  }
}

ログイン後にコピー

(3) コンポーネント内の UseWording クラスを inerit します。

import { Component } from '@angular/core';
import UseWording from '../../../shared/translations/use-wording';

@Component({...})
export class HomeComponent extends UseWording {
  readonly pageText = this.useWording.MOVIES.BATMAN
}

ログイン後にコピー

これにより、テンプレート内のインテリセンスをすぐに確認できるようになります。

Abstract text content in Angular

さらに、文言オブジェクト内の特定のキーを対象とするクラスプロパティをさらに作成できます。

@Component({...})
export class HomeComponent extends UseWording {
  readonly pageText = this.useWording.MOVIES.BATMAN;
  readonly movies = this.useWording.MOVIES.BATMAN.SERIES.THE_DARK_KNIGHT.MOVIES;
  readonly common = this.useWording.COMMON;
}

ログイン後にコピー

<div class="movie-main">
  <div class="movie-main-container">
    <span class="heading0">{{ pageText.TITLE }}</span>
    <div class="heading4">{{ pageText.SERIES.THE_DARK_KNIGHT.TITLE }}</div>
  </div>

  <div class="movie-main-cards">
    <div class="layout-centered">
      <div class="heading1">{{ movies.BATMAN_BEGINS.TITLE }}</div>
      <div class="heading4">
        {{ movies.BATMAN_BEGINS.DESCRIPTION }}
      </div>
      <button class="button-primary">{{ common.BUTTON }}</button>
    </div>
    <div class="layout-centered">
      <div class="heading1">{{ movies.THE_DARK_KNIGHT.TITLE }}</div>
      <div class="heading4">
        {{ movies.THE_DARK_KNIGHT.DESCRIPTION }}
      </div>
      <button class="button-primary">{{ common.BUTTON }}</button>
    </div>
    <div class="layout-centered">
      <div class="heading1">
        {{ movies.THE_DARK_KNIGHT_RISES.TITLE }}
        <div class="heading4">
          {{ movies.THE_DARK_KNIGHT_RISES.DESCRIPTION }}
        </div>
        <button class="button-primary">{{ common.BUTTON }}</button>
      </div>
    </div>
  </div>
</div>

ログイン後にコピー

クラスコンポーネントがコンストラクター経由で依存関係を挿入する場合、コンストラクターには「スーパー」呼び出しが含まれている必要があることに注意してください。

export class MyComponent extends UseWording {

  searchAccountsForm!: FormGroup;

  constructor(
    private fb: FormBuilder
  ) {
    super(); // <-- this is mandatory
  }

ログイン後にコピー

JSON と同様に、タイトルや説明を変更する必要がある場合は、複数のファイル/コンポーネントを変更するのではなく、1 か所 (wording.ts) で変更します。