Osadzanie stron w treści

Shayan TaslimZaktualizowano

Osadzone strony wyświetlają publiczne strony UserJot w układzie własnej aplikacji zamiast w pływającym widżecie. Możesz osadzić tablice opinii, roadmapę, changelog i centrum pomocy. Widok Messages z Conversations jest dostępny tylko w widżecie i nie można go osadzić.

Podstawowa konfiguracja

Dodaj do strony element kontenera:

HTML
<div data-userjot-embed style="height: 700px"></div>

Następnie zainicjuj SDK i zamontuj osadzoną stronę:

JavaScript
uj.init('YOUR_PROJECT_ID', { widget: false });
uj.createEmbed();

Osadzona strona wypełnia swój kontener, dlatego ustaw wysokość kontenera za pomocą CSS. Przekazanie widget: false wyłącza pływający widżet. Możesz też pozostawić go włączonego i korzystać z obu rozwiązań jednocześnie.

Opcje i obsługiwane ścieżki

JavaScript
uj.createEmbed({
  container: '#my-container', // CSS selector or DOM element, default '[data-userjot-embed]'
  path: '/roadmap',           // initial page, default '/'
  theme: 'auto'               // 'auto', 'light', or 'dark'
});

Prawidłowe wartości path:

Ścieżka

Co wyświetla

/ (lub /feedback)

Twoja domyślna tablica opinii

/feedback/<board-slug>

Konkretna publiczna tablica

/feedback/p/<post-slug>

Konkretna opinia

/roadmap

Publiczna roadmapa

/updates

Strona główna changeloga

/updates/<slug>

Konkretna aktualizacja changeloga

/help

Strona główna centrum pomocy (gdy jest opublikowane)

/help/collections/<slug>

Konkretna kolekcja w centrum pomocy

/help/articles/<slug>

Konkretny artykuł w centrum pomocy

Starsze ścieżki /board/<board-slug> i /board/p/<post-slug> przekierowują do /feedback/<board-slug> i /feedback/p/<post-slug>.

Sterowanie osadzonym elementem

uj.createEmbed zwraca kontroler po załadowaniu skryptu SDK:

JavaScript
const embed = uj.createEmbed({ path: '/' });

embed.navigate('/roadmap'); // switch to another page
embed.destroy();            // unmount the embed

Synchronizacja z adresem URL

Przekaż basePath, aby osadzona strona synchronizowała adres URL przeglądarki podczas nawigacji użytkowników:

JavaScript
uj.createEmbed({
  container: '#feedback-page',
  basePath: '/feedback'
});

W przypadku basePath: '/feedback' główna strona opinii pozostaje pod adresem /feedback, a otwarcie wpisu aktualizuje adres URL w przeglądarce do /feedback/feedback/p/<post-slug>. Bezpośrednie wczytanie tego adresu URL otwiera osadzoną stronę z tym wpisem.

Aby precyzyjne linki działały, skonfiguruj router aplikacji tak, aby zarówno /feedback, jak i /feedback/* wyświetlały stronę wywołującą uj.createEmbed.

Tożsamość jest przekazywana automatycznie

Wywołanie uj.identify loguje użytkownika do wszystkich osadzonych stron na stronie (również tych utworzonych później), a wywołanie uj.logout go wylogowuje.

Logowanie użytkowników do osadzonych stron odbywa się za pośrednictwem funkcji Automatyczne logowanie. Upewnij się, że funkcja Automatyczne logowanie jest włączona w Ustawieniach → Logowanie (plan Starter lub Professional). Jeśli nie jest włączona, użytkownicy będą wylogowani z osadzonych stron, nawet jeśli przekażesz tożsamość zalogowanego użytkownika.

JavaScript
uj.identify({ token: 'TOKEN_FROM_YOUR_SERVER' });
uj.createEmbed();

Wiele osadzonych elementów

Możesz zamontować kilka osadzonych stron na tej samej stronie, przypisując każdej własny kontener i ścieżkę:

JavaScript
uj.createEmbed({ container: '#board', path: '/' });
uj.createEmbed({ container: '#roadmap', path: '/roadmap' });

Osadzony element czy widżet?

  • Użyj widżetu, gdy chcesz mieć opinie, pomoc, aktualizacje i wiadomości zawsze pod ręką w dowolnym miejscu aplikacji.

  • Użyj osadzonej strony, gdy chcesz umieścić dedykowaną stronę we własnym układzie, na przykład yourapp.com/feedback lub yourapp.com/help.

Wiele produktów korzysta z obu rozwiązań. Wszystkie opcje osadzania znajdziesz w dokumentacji SDK.

Czy ten artykuł odpowiedział na Twoje pytanie?