npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@mi18n/svelte

v5.15.1

Published

Svelte implementation for Mi18n localization framework

Downloads

4

Readme

Logo

Mi18n is an open-source alternative to Crowdin, Phrase, or Lokalise with its very own revolutionary integrations.

test workflow

@mi18n/svelte version

types typescript typescript licence github stars github stars Github discussions

Become part of the family. Join slack channel

What is Mi18n for Svelte?

Svelte integration library of Mi18n. With this package, it's super simple to add i18n to your Svelte app! For more information about using Mi18n with Svelte, visit the docs 📖.

Localize (translate) your Svelte or SvelteKit projects to multiple languages with Mi18n. Integration of Mi18n is extremely simple! 🇯🇵 🇰🇷 🇩🇪 🇨🇳 🇺🇸 🇫🇷 🇪🇸 🇮🇹 🇷🇺 🇬🇧

Quick links

Installation

npm install @mi18n/svelte

Then use the library in your app:

<script lang="ts">
  import {
    Mi18nProvider,
    Mi18n,
    SveltePlugin,
    FormatSimple,
  } from '@mi18n/svelte';

  const mi18n = Mi18n()
    .use(SveltePlugin())
    .use(FormatSimple())
    .init({
      apiUrl: import.meta.env.VITE_MI18N_API_URL,
      apiKey: import.meta.env.VITE_MI18N_API_KEY,
      language: 'en',
    });
</script>

<Mi18nProvider {mi18n}>
  <div slot="fallback">Loading...</div>
  <slot />
</Mi18nProvider>

Usage

To translate texts using Mi18n Svelte integration, you can use T component or getTranslate function.

T component

<script>
  import { T } from '@mi18n/svelte';
</script>

<T keyName="key" defaultValue="This is default" />

getTranslate function

The getTranslate function returns a store containing the function, which translates your key.

<script>
  import { getTranslate } from '@mi18n/svelte';

  const { t } = getTranslate();
</script>

{$t('this_is_a_key', { key: 'value', key2: 'value2' })}

Changing the language

To change the current language, use getLanguageStore method. For example, you can bind it to a select value.

<script lang="ts">
  import { getMi18n } from '@mi18n/svelte';

  const mi18n = getMi18n(['language']);

  function handleLanguageChange(e) {
    $mi18n.changeLanguage(e.currentTarget.value);
  }
</script>

<select value={$mi18n.getLanguage()} on:change={handleLanguageChange}>
  ...
</select>

Prerequisites

  1. You have some Svelte-based project
  2. You have generated an API key from Mi18n Cloud or a self-hosted Mi18n instance.

Why to use Mi18n?

Because it saves a lot of time, you would spend on localization tasks without it. Because it enables you to provide perfectly translated software.

Features

  • All-in-one localization solution for your JS application 🙌
  • Out-of-box in-context localization 🎉
  • Automated screenshot generation 📷
  • Translation management platform 🎈
  • Open-source 🔥

Frame 47 Read more on the Mi18n website

Development

We welcome your PRs.

To develop the package locally:

  1. Clone the repository
  2. Install the packages in the repository root
pnpm install
  1. Run the development script
pnpm develop:svelte

This runs the development suite of this monorepo for the svelte integration. The changes in each dependency package are automatically built and propagated to the test application, which you can open and play within the browser.

Testing

To run Jest tests of this package, execute

npm run test

In the /packages/svelte directory.

End-to-end (e2e) testing

To run the e2e tests, simply execute

pnpm run e2e run svelte

To open and play with e2e tests, run:

pnpm run e2e open svelte

Contributors