د وېبپاڼې ویجټ

دا پاڼه له انګلیسي ژبې ژباړل شوې ده. که دواړه سره توپیر ولري، انګلیسي پاڼه سمه ده. انګلیسي پاڼه ولولئ

په یوه وېبپاڼه کې، Lingara د یوه ځانګړي عنصر، <lingara-embed>، په توګه چلېږي. عنصر د Lingara تمرین په یوه چوکاټ کې انځوروي چې Lingara یې وړاندې کوي، نو ستاسو پاڼه هېڅکله د زده کوونکي معلومات نه ویني او د Lingara پاڼه هېڅکله ستاسو معلومات نه ویني.

عنصر کېږدئ

@lingara/embed له npm څخه نصب کړئ، یا که ستاسو سایټ bundler نه لري د هغه ماډیول جوړښت له یوه CDN څخه بار کړئ. بیا <lingara-embed> په پاڼه کې کېږدئ او تعریف یې کړئ. عنصر دا اخلي:

plan-id، هغه د لوست پلان چې تمرین کېږي، یو چې د لوبغاړي خپل وي؛
surface، څه وښيي: practice، ډیفالټ او یوازینی سطح چې شته؛
theme، له دې څخه یو: light، dark یا auto؛
locale، د چوکاټ د خپلو کلمو ژبه، چې که نه وي د زده کوونکي ژبه تعقیبوي؛
title، د چوکاټ د لاسرسي وړ نوم.

سینګار په تیم پای ته رسي. ستاسو پاڼه د چوکاټ دننه نه شي رسېدای، او تیم یوازینی تنظیم دی چې دا یې وړاندې کوي.

هغه ته ټوکنونه ورکړئ

د عنصر tokenProvider داسې فنکشن ته وټاکئ چې له خپل سرور څخه ټوکن وغواړي. ستاسو سرور هغه د پاڼې د origin سره جوړوي، د یوه سرور کیټ په کارولو، او د ټوکن او د هغه د پای ته رسېدو د وخت په لېږلو ځواب ورکوي. عنصر ټوکن د پیغام له لارې چوکاټ ته سپاري، او هېڅکله په URL کې نه سفر کوي.

هر هغه origin چې ویجټ پرې چلېږي د هغه لپاره د ټوکن جوړولو مخکې ثبت کړئ، په کنسول کې د خپل کلاینټ په تنظیماتو کې. د سرور کیټونو پاڼه وايي چې څنګه. API هغه ټوکن ردوي چې د بل هر origin لپاره جوړ شوی وي، او چوکاټ د تمرین پر ځای یوه تېروتنه ښيي.

د سرور کیټ کولی شي ستاسو لپاره ټوله ټوټه هم ولیکي، عنصر او د ټوکن ورکوونکی یو ځای، د ستاسو د پاڼې د script nonce سره که ستاسو د منځپانګې د امنیت پالیسي یوه ته اړتیا ولري. لاندې وروستۍ نمونه دا ښيي.

هغه څه واورئ چې چوکاټ یې وايي

چوکاټ له عنصر سره د یوه نسخه لرونکي پیغام پروتوکول له لارې خبرې کوي، او عنصر هغه څه چې ستاسو پاڼه یې اړتیا لري په DOM پېښو بدلوي:

lingara:practice-completed کله چې زده کوونکی یو سېټ بشپړ کړي، د هغه د planId، setNumber، correct او total سره؛
lingara:error کله چې چوکاټ ودرېږي، د یوه code او retryable سره. د بیا هڅې وړ تېروتنه دا معنا لري چې یو تازه کېښودل کېدای شي بریالی شي؛ دا چې کله بیا هڅه وکړئ ستاسو پرېکړه ده.

د تمرین پایله ستاسو سرور ته هم رسي، لکه څنګه چې په د تمرین پایلې کې تشریح شوې.

npm install @lingara/embed@0.1.0-alpha.6
# No bundler? One module script instead:
# <script type="module" src="https://cdn.jsdelivr.net/npm/@lingara/embed@0.1.0-alpha.6/dist/lingara-embed.min.js"></script>

<!-- plan-id is a lesson plan your server made for this player. -->
<lingara-embed surface="practice" plan-id="0b9d4f2e-3c1a-4e8b-9f6d-2a7c5e1b8d40" theme="auto" title="Practice"></lingara-embed>
<script type="module">
  import { defineLingaraEmbed } from '@lingara/embed'
  defineLingaraEmbed()
</script>

// Your own endpoint, on your own server. It mints with this page's origin and
// returns exactly { token, expires_at }: the token (lgr_et_…) never touches a URL.
widget.tokenProvider = async () => {
  const response = await fetch('/lingara/token', { method: 'POST', credentials: 'same-origin' })
  if (!response.ok) throw new Error(`token endpoint answered ${response.status}`)
  return response.json()
}

widget.addEventListener('lingara:practice-completed', (event) => {
  const { planId, setNumber, correct, total } = (event as CustomEvent).detail
  console.log(`set ${setNumber} of ${planId}: ${correct}/${total}`)
})
widget.addEventListener('lingara:error', (event) => {
  const { code, retryable } = (event as CustomEvent).detail
  // `retryable` means a remount may succeed; when to try is yours to decide.
  if (retryable) setTimeout(() => widget.reload(), 30_000)
  else console.warn('Lingara practice stopped:', code)
})

TypeScriptRustGoJavaKotlinRubyPHPC#

TypeScript

// The page that mounts the widget: the token never appears in it.
export function practicePage(planId: string, cspNonce: string): string {
  const widget = widgetSnippet({ planId, tokenEndpoint: '/lingara/token', theme: 'auto', locale: 'fr', title: 'Pratique', nonce: cspNonce })
  return `<!doctype html><title>Practice</title>${widget}`
}

Rust

// The element, its script build and a token provider that POSTs to your
// token route. The token never appears in the markup.
let html = widget_snippet(&SnippetOptions {
    locale: Some("fr".into()),
    nonce: Some(csp_nonce.into()), // your page's CSP nonce, for a strict script-src
    ..SnippetOptions::new(plan_id, "/lingara/token")
})?;

// The plan your server made for this player, and the token route above.
// Pass the request's CSP nonce when your script-src allows no inline
// script; the token itself never appears in the markup.
theme := "auto"
html, err := lingaraembed.WidgetSnippet(lingaraembed.SnippetOptions{
	PlanID:        planID,
	TokenEndpoint: "/lingara/token",
	Theme:         &theme,
	Nonce:         &cspNonce,
})
if err != nil {
	return "", err // a *lingaraembed.SnippetError names the refused option
}
return template.HTML(html), nil // already escaped by the kit

Java

// planId is the lesson plan your server made for this player. The element
// POSTs to tokenEndpoint with same-origin cookies: the token never appears
// in the markup. Pass this request's CSP nonce if your page sets one.
String html =
    WidgetSnippet.render(
        SnippetOptions.builder(planId, "/lingara/token").locale("fr").nonce(cspNonce).build());

Kotlin

// planId is the lesson plan your server made for this player. The element
// POSTs to tokenEndpoint with same-origin cookies: the token never appears
// in the markup. Pass this request's CSP nonce if your page sets one.
val html =
    widgetSnippet(
        SnippetOptions(planId, tokenEndpoint = "/lingara/token").apply {
            locale = "fr"
            nonce = cspNonce
        },
    )

Ruby

# The plan your server made for this player, rendered into your page.
# nonce: your page's CSP nonce, when its script-src allows no inline script.
def self.widget(plan_id, csp_nonce)
  Lingara::Embed.widget_snippet(plan_id: plan_id, token_endpoint: "/lingara/token", locale: "fr", nonce: csp_nonce)
end

PHP

use Lingara\Embed\SnippetOptions;
use Lingara\Embed\WidgetSnippet;

// In your page's template: the plan your server made for this player, and
// your token route. Pass the request's CSP nonce if your script-src allows
// no inline script. A bad option throws SnippetException naming its field.
function practiceWidget(string $planId, string $cspNonce): string
{
    return WidgetSnippet::render(new SnippetOptions(
        planId: $planId,
        tokenEndpoint: '/lingara/token',
        theme: 'auto',
        nonce: $cspNonce,
    ));
}

app.MapGet("/practice/{planId}", (string planId, HttpContext http) =>
{
    var widget = WidgetSnippet.Render(new SnippetOptions
    {
        PlanId = planId,                              // the plan your server made for this player
        TokenEndpoint = "/lingara/token",             // same origin: the element sends this page's cookies
        Nonce = http.Items["csp-nonce"] as string,     // your CSP's nonce, if script-src has one
    });
    return Results.Content($"<!doctype html><title>Practice</title>\n{widget}", "text/html");
}).RequireAuthorization();