이 페이지와 원하는 AI 어시스턴트를 사용하여 문서를 요약합니다
버전 기록
- "Solid useIntlayer API 사용법을 직접 속성 액세스로 업데이트"v8.9.02026. 5. 4.
- "초기 기록"v8.4.102026. 3. 23.
이 페이지의 콘텐츠는 AI를 사용하여 번역되었습니다.
영어 원본 내용의 최신 버전을 보기If you have an idea for improving this documentation, please feel free to contribute by submitting a pull request on GitHub.
GitHub link to the documentationCopy doc Markdown to clipboard
Intlayer를 사용하여 Vite 및 Lit 웹사이트 번역하기 | 국제화 (i18n)
목차
Intlayer란 무엇인가요?
Intlayer는 현대적인 웹 애플리케이션에서 다국어 지원을 간소화하도록 설계된 혁신적인 오픈 소스 국제화(i18n) 라이브러리입니다.
Intlayer를 사용하면 다음과 같은 이점이 있습니다:
- 컴포넌트 수준의 선언적 딕셔너리를 사용하여 번역을 쉽게 관리할 수 있습니다.
- 메타데이터, 라우트 및 콘텐츠를 동적으로 로컬라이즈할 수 있습니다.
- 자동 생성된 타입을 통해 TypeScript 지원을 보장하여 자동 완성 및 오류 감지 기능을 향상시킵니다.
- 동적 로케일 감지 및 전환과 같은 고급 기능을 활용할 수 있습니다.
Vite 및 Lit 애플리케이션에서 Intlayer를 설정하기 위한 단계별 가이드
1단계: 종속성 설치
npm을 사용하여 필요한 패키지를 설치합니다:
코드를 클립보드에 복사
npm install intlayer lit-intlayernpm install vite-intlayer --save-devnpx intlayer initintlayer
구성 관리, 번역, 콘텐츠 선언, 트랜스파일 및 CLI 명령을 위한 국제화 도구를 제공하는 핵심 패키지입니다.
lit-intlayer Intlayer를 Lit 애플리케이션과 통합하는 패키지입니다.
ReactiveController기반 훅(useIntlayer,useLocale등)을 제공하여 로케일이 변경될 때 LitElement가 자동으로 다시 렌더링되도록 합니다.vite-intlayer Intlayer를 Vite 번들러와 통합하기 위한 Vite 플러그인과 사용자의 선호 로케일 감지, 쿠키 관리 및 URL 리디렉션 처리를 위한 미들웨어가 포함되어 있습니다.
2단계: 프로젝트 구성
애플리케이션의 언어를 구성하기 위한 설정 파일을 만듭니다:
코드를 클립보드에 복사
import { Locales, type IntlayerConfig } from "intlayer";
const config: IntlayerConfig = {
internationalization: {
locales: [
Locales.ENGLISH,
Locales.FRENCH,
Locales.SPANISH,
// 기타 로케일
],
defaultLocale: Locales.ENGLISH,
},
};
export default config;이 구성 파일을 통해 로컬라이즈된 URL, 미들웨어 리디렉션, 쿠키 이름, 콘텐츠 선언 위치 및 확장자, 콘솔 내 Intlayer 로그 비활성화 등을 설정할 수 있습니다. 사용 가능한 매개변수의 전체 목록은 구성 문서를 참조하세요.
3단계: Vite 구성에 Intlayer 통합
Vite 구성에 intlayer 플러그인을 추가합니다.
코드를 클립보드에 복사
import { defineConfig } from "vite";
import { intlayer } from "vite-intlayer";
// https://vitejs.dev/config/
export default defineConfig({
plugins: [intlayer()],
});intlayer() Vite 플러그인은 Intlayer를 Vite와 통합하는 데 사용됩니다. 콘텐츠 선언 파일의 빌드를 보장하고 개발 모드에서 이를 모니터링합니다. Vite 애플리케이션 내에 Intlayer 환경 변수를 정의합니다. 또한 성능 최적화를 위한 별칭을 제공합니다.
4단계: 엔트리 포인트에서 Intlayer 부트스트랩
첫 번째 엘리먼트가 연결될 때 글로벌 로케일 싱글톤이 준비되도록 커스텀 엘리먼트가 등록되기 전에 installIntlayer()를 호출하세요.
코드를 클립보드에 복사
import { installIntlayer } from "lit-intlayer";// LitElement가 DOM에 연결되기 전에 호출해야 합니다.installIntlayer();// 커스텀 엘리먼트를 임포트하고 등록합니다.import "./my-element.js";md() 콘텐츠 선언(Markdown)도 사용하는 경우 마크다운 렌더러도 설치하세요:
코드를 클립보드에 복사
import { installIntlayer, installIntlayerMarkdown } from "lit-intlayer";installIntlayer();installIntlayerMarkdown();import "./my-element.js";5단계: 콘텐츠 선언
번역을 저장하기 위한 콘텐츠 선언을 생성하고 관리합니다:
코드를 클립보드에 복사
import { t, type Dictionary } from "intlayer";
const appContent = {
key: "app",
content: {
title: "Vite + Lit",
viteLogo: t({
en: "Vite logo",
fr: "Logo Vite",
es: "Logo Vite",
}),
litLogo: t({
en: "Lit logo",
fr: "Logo Lit",
es: "Logo Lit",
}),
count: t({
en: "count is {{count}}",
fr: "le compte est {{count}}",
es: "el recuento es {{count}}",
}),
readTheDocs: t({
en: "Click on the Vite and Lit logos to learn more",
fr: "Cliquez sur les logos Vite et Lit pour en savoir plus",
es: "Haga clic en los logotipos de Vite y Lit para obtener más información",
}),
},
} satisfies Dictionary;
export default appContent;콘텐츠 선언은
contentDir디렉토리(기본값./src)에 포함되고 콘텐츠 선언 파일 확장자(기본값.content.{json,ts,tsx,js,jsx,mjs,cjs})와 일치하는 경우 애플리케이션 어디에서나 정의할 수 있습니다.자세한 내용은 콘텐츠 선언 문서를 참조하세요.
6단계: LitElement에서 Intlayer 활용
LitElement 내에서 useIntlayer를 사용합니다. 활성 로케일이 변경될 때마다 자동으로 다시 렌더링을 트리거하는 ReactiveController 프록시를 반환하며 별도의 설정이 필요하지 않습니다.
코드를 클립보드에 복사
import { LitElement, html } from "lit";import { customElement, property } from "lit/decorators.js";import { useIntlayer } from "lit-intlayer";@customElement("my-element")export class MyElement extends LitElement { @property({ type: Number }) count = 0; // useIntlayer는 자신을 ReactiveController로 등록합니다. // 로케일이 변경되면 엘리먼트가 자동으로 다시 렌더링됩니다. private content = useIntlayer(this, "app"); override render() { const { content } = this; return html` <h1>${content.title}</h1> <img src="/vite.svg" alt=${content.viteLogo.value} /> <img src="/lit.svg" alt=${content.litLogo.value} /> <button @click=${() => this.count++}> ${content.count({ count: this.count })} </button> <p>${content.readTheDocs}</p> `; }}네이티브 HTML 속성(예:
alt,aria-label,title)에서 번역된 문자열이 필요한 경우 리프 노드에서.value를 호출하세요:typescript코드 복사코드를 클립보드에 복사
html`<img alt=${content.viteLogo.value} />`;html`<img alt=${content.viteLogo.toString()} />`;html`<img alt=${String(content.viteLogo)} />`;
(선택 사항) 7단계: 콘텐츠 언어 변경
콘텐츠 언어를 변경하려면 useLocale 컨트롤러에서 노출하는 setLocale 메서드를 사용합니다.
코드를 클립보드에 복사
import { LitElement, html } from "lit";import { customElement } from "lit/decorators.js";import { getLocaleName } from "intlayer";import { useLocale } from "lit-intlayer";@customElement("locale-switcher")export class LocaleSwitcher extends LitElement { private locale = useLocale(this); private _onChange(e: Event) { const select = e.target as HTMLSelectElement; this.locale.setLocale(select.value as any); } override render() { return html` <select @change=${this._onChange}> ${this.locale.availableLocales.map( (loc) => html` <option value=${loc} ?selected=${loc === this.locale.locale}> ${getLocaleName(loc)} </option> ` )} </select> `; }}(선택 사항) 8단계: 마크다운 및 HTML 콘텐츠 렌더링
Intlayer는 md() 및 html() 콘텐츠 선언을 지원합니다. Lit에서 컴파일된 출력은 unsafeHTML 디렉티브를 통해 원시 HTML로 삽입됩니다.
엘리먼트에서 컴파일된 HTML을 렌더링합니다:
코드를 클립보드에 복사
import { LitElement, html } from "lit";import { customElement } from "lit/decorators.js";import { unsafeHTML } from "lit/directives/unsafe-html.js";import { useIntlayer } from "lit-intlayer";import { compileMarkdown } from "lit-intlayer/markdown";@customElement("my-element")export class MyElement extends LitElement { private content = useIntlayer(this, "app"); override render() { return html` <div class="edit-note"> ${unsafeHTML(compileMarkdown(String(this.content.editNote)))} </div> `; }}TIP String(content.editNote)는 원시 마크다운 문자열을 반환하는IntlayerNode의toString()을 호출합니다. 이를compileMarkdown에 전달하여 HTML 문자열을 가져온 다음 Lit의unsafeHTML디렉티브로 렌더링합니다.
(선택 사항) 9단계: 애플리케이션에 로컬라이즈된 라우팅 추가
각 언어에 대해 고유한 라우트를 만들려면(SEO에 유용) Intlayer의 localeMap / localeFlatMap 헬퍼와 서버 측 로케일 감지를 위한 intlayerProxy Vite 플러그인과 함께 클라이언트 측 라우터를 사용할 수 있습니다.
먼저 Vite 구성에 intlayerProxy를 추가합니다:
프로덕션에서intlayerProxy를 사용하려면vite-intlayer를devDependencies에서dependencies로 이동해야 합니다.
코드를 클립보드에 복사
import { defineConfig } from "vite";
import { intlayer, intlayerProxy } from "vite-intlayer";
export default defineConfig({
plugins: [
intlayerProxy(), // should be placed first
intlayer(),
],
});(선택 사항) 10단계: 로케일 변경 시 URL 변경
로케일이 변경될 때 브라우저 URL을 업데이트하려면 로케일 스위처와 함께 useRewriteURL을 사용합니다:
코드를 클립보드에 복사
import { LitElement, html } from "lit";import { customElement } from "lit/decorators.js";import { getLocaleName, getLocalizedUrl } from "intlayer";import { useLocale, useRewriteURL } from "lit-intlayer";@customElement("locale-switcher")export class LocaleSwitcher extends LitElement { private locale = useLocale(this); // 로케일이 변경될 때 현재 URL을 자동으로 다시 작성합니다. private _rewriteURL = useRewriteURL(this); private _onChange(e: Event) { const select = e.target as HTMLSelectElement; this.locale.setLocale(select.value as any); } override render() { return html` <select @change=${this._onChange}> ${this.locale.availableLocales.map( (loc) => html` <option value=${loc} ?selected=${loc === this.locale.locale}> ${getLocaleName(loc)} </option> ` )} </select> `; }}(선택 사항) 11단계: HTML 언어 및 방향 속성 전환
접근성 및 SEO를 위해 현재 로케일에 맞게 <html> 태그의 lang 및 dir 속성을 업데이트합니다.
코드를 클립보드에 복사
import { LitElement, html } from "lit";import { customElement } from "lit/decorators.js";import { getHTMLTextDir } from "intlayer";import { useLocale } from "lit-intlayer";@customElement("my-element")export class MyElement extends LitElement { private locale = useLocale(this, { onLocaleChange: (loc) => { document.documentElement.lang = loc; document.documentElement.dir = getHTMLTextDir(loc); }, }); override render() { return html`<!-- 여러분의 콘텐츠 -->`; }}(선택 사항) 12단계: 컴포넌트의 콘텐츠 추출
기존 코드베이스가 있는 경우 수천 개의 파일을 변환하는 데 시간이 많이 걸릴 수 있습니다.
이 프로세스를 쉽게 하기 위해 Intlayer는 컴포넌트를 변환하고 콘텐츠를 추출하는 컴파일러 / 추출기를 제안합니다.
설정하려면 intlayer.config.ts 파일에 compiler 섹션을 추가하면 됩니다:
코드를 클립보드에 복사
import { type IntlayerConfig } from "intlayer";const config: IntlayerConfig = { // ... 나머지 구성 compiler: { /** * 컴파일러를 활성화할지 여부를 나타냅니다. */ enabled: true, /** * 출력 파일 경로를 정의합니다. */ output: ({ fileName, extension }) => `./${fileName}${extension}`, /** * 변환된 후 컴포넌트를 저장할지 여부를 나타냅니다. * 이렇게 하면 컴파일러를 한 번만 실행하여 앱을 변환한 다음 나중에 제거할 수 있습니다. */ saveComponents: false, /** * 딕셔너리 키 접두사 */ dictionaryKeyPrefix: "", },};export default config;(선택) 사이트맵과 robots.txt(빌드 시 생성)
Intlayer는 generateSitemap과 getMultilingualUrls로 크롤러용 다국어 sitemap.xml과 robots.txt를 만들어 public/에 자동으로 쓸 수 있습니다. 보통 Vite 실행 전에 작은 Node 스크립트를 돌립니다(예: npm predev / prebuild).
사이트맵
Intlayer 사이트맵 생성기는 로케일 설정을 반영하고 크롤러용 메타데이터를 포함합니다.
생성된 사이트맵은xhtml:link(hreflang)를 지원합니다. 단순 URL 나열이 아니라 각 페이지의 모든 언어 버전을 양방향으로 연결합니다(예:/about,/fr/about,/about?lang=fr- 라우팅 모드에 따름).
Robots.txt
getMultilingualUrls로 Disallow가 민감 경로의 모든 현지화 변형에 적용되도록 하세요.
1. 프로젝트 루트에 generate-seo.mjs 추가
코드를 클립보드에 복사
import fs from "fs";import path from "path";import { fileURLToPath } from "url";import { generateSitemap, getMultilingualUrls } from "intlayer";const __dirname = path.dirname(fileURLToPath(import.meta.url));const SITE_URL = (process.env.SITE_URL || "http://localhost:5173").replace( /\/$/, "");const pathList = [ { path: "/", changefreq: "daily", priority: 1.0 }, { path: "/about", changefreq: "monthly", priority: 0.7 },];const sitemapXml = generateSitemap(pathList, { siteUrl: SITE_URL });fs.writeFileSync(path.join(__dirname, "public", "sitemap.xml"), sitemapXml);const getAllMultilingualUrls = (urls) => urls.flatMap((url) => Object.values(getMultilingualUrls(url)));const disallowedPaths = getAllMultilingualUrls(["/admin", "/private"]);const robotsTxt = [ "User-agent: *", "Allow: /", ...disallowedPaths.map((path) => `Disallow: ${path}`), "", `Sitemap: ${SITE_URL}/sitemap.xml`,].join("\n");fs.writeFileSync(path.join(__dirname, "public", "robots.txt"), robotsTxt);console.log("SEO files generated successfully.");스크립트가 intlayer를 import하려면 패키지가 설치되어 있어야 합니다. 프로덕션에서는 환경 변수 SITE_URL을 설정하세요(CI 등).
Node ESM에는generate-seo.mjs사용을 권장합니다.generate-seo.js를 쓰면package.json의"type": "module"등으로 ESM을 켜세요.
2. Vite 전에 스크립트 실행
코드를 클립보드에 복사
{ "scripts": { "dev": "vite", "prebuild": "node generate-seo.mjs", "build": "vite build", "preview": "vite preview" }}pnpm이나 yarn을 쓰면 명령을 맞게 바꾸세요. CI에서 호출해도 됩니다.
TypeScript 구성
TypeScript 구성에 자동 생성된 타입이 포함되어 있는지 확인하세요.
코드를 클립보드에 복사
{ "compilerOptions": { // ... "experimentalDecorators": true, "useDefineForClassFields": false, }, "include": ["src", ".intlayer/**/*.ts"],}experimentalDecorators및useDefineForClassFields: false는 Lit에서 데코레이터 지원을 위해 필요합니다.
Git 구성
Intlayer에서 생성된 파일은 무시하는 것이 좋습니다. 이렇게 하면 Git 저장소에 커밋하는 것을 방지할 수 있습니다.
이렇게 하려면 .gitignore 파일에 다음 지침을 추가하면 됩니다:
코드를 클립보드에 복사
# Intlayer에서 생성된 파일 무시.intlayerVS Code 확장 프로그램
Intlayer 개발 환경을 개선하기 위해 공식 Intlayer VS Code Extension을 설치할 수 있습니다.
이 확장 프로그램은 다음을 제공합니다:
- 번역 키에 대한 자동 완성.
- 누락된 번역에 대한 실시간 오류 감지.
- 번역된 콘텐츠의 인라인 미리보기.
- 번역을 쉽게 생성하고 업데이트할 수 있는 빠른 작업.
확장 프로그램 사용 방법에 대한 자세한 내용은 Intlayer VS Code Extension 문서를 참조하세요.