Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix x-codeSamples load when switching language tabs #707

Merged
merged 4 commits into from
Jan 24, 2024
Merged

Fix x-codeSamples load when switching language tabs #707

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
27e4ec9
fix x-codeSamples load when switch language tabs
lucasassisrosa Jan 18, 2024
a06cbab
remove irrelevant changes
lucasassisrosa Jan 18, 2024
d1e0831
set code sample text on initial state load
lucasassisrosa Jan 22, 2024
7398453
add missing eol
lucasassisrosa Jan 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/CodeSnippets/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,10 @@ import { useTypedSelector } from "@theme/ApiItem/hooks";
import merge from "lodash/merge";

import { CodeSample, Language } from "./code-snippets-types";
import { mergeCodeSampleLanguage } from "./languages";
import {
getCodeSampleSourceFromLanguage,
mergeCodeSampleLanguage,
} from "./languages";

export const languageSet: Language[] = [
{
Expand Down Expand Up @@ -198,20 +201,13 @@ function CodeSnippets({ postman, codeSamples }: Props) {
return defaultLang[0] ?? mergedLangs[0];
});
const [codeText, setCodeText] = useState<string>("");
const [codeSampleCodeText, setCodeSampleCodeText] = useState<string>("");
const [codeSampleCodeText, setCodeSampleCodeText] = useState<
string | (() => string)
>(() => getCodeSampleSourceFromLanguage(language));

useEffect(() => {
// initial active language is custom code sample
if (
language &&
language.sample &&
language.samples &&
language.samplesSources
) {
const sampleIndex = language.samples.findIndex(
(smp) => smp === language.sample
);
setCodeSampleCodeText(language.samplesSources[sampleIndex]);
if (language && !!language.sample) {
setCodeSampleCodeText(getCodeSampleSourceFromLanguage(language));
}

if (language && !!language.options) {
Expand Down Expand Up @@ -344,7 +340,9 @@ function CodeSnippets({ postman, codeSamples }: Props) {
action={{
setLanguage: setLanguage,
setSelectedVariant: setSelectedVariant,
setSelectedSample: setSelectedSample,
}}
languageSet={mergedLangs}
lazy
>
{mergedLangs.map((lang) => {
Expand All @@ -367,6 +365,7 @@ function CodeSnippets({ postman, codeSamples }: Props) {
includeSample={true}
currentLanguage={lang.language}
defaultValue={selectedSample}
languageSet={mergedLangs}
lazy
>
{lang.samples.map((sample, index) => {
Expand Down Expand Up @@ -406,6 +405,7 @@ function CodeSnippets({ postman, codeSamples }: Props) {
includeVariant={true}
currentLanguage={lang.language}
defaultValue={selectedVariant}
languageSet={mergedLangs}
lazy
>
{lang.variants.map((variant, index) => {
Expand Down
16 changes: 16 additions & 0 deletions packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/CodeSnippets/languages.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,19 @@ export function mergeCodeSampleLanguage(
return language;
});
}

export function getCodeSampleSourceFromLanguage(language: Language) {
if (
language &&
language.sample &&
language.samples &&
language.samplesSources
) {
const sampleIndex = language.samples.findIndex(
(smp) => smp === language.sample
);
return language.samplesSources[sampleIndex];
}

return "";
}
14 changes: 8 additions & 6 deletions packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/CodeTabs/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ import {
useTabs,
} from "@docusaurus/theme-common/internal";
import useIsBrowser from "@docusaurus/useIsBrowser";
import { languageSet } from "@theme/ApiExplorer/CodeSnippets";
import clsx from "clsx";

function TabList({
action,
currentLanguage,
languageSet,
includeVariant,
includeSample,
className,
Expand Down Expand Up @@ -48,16 +48,18 @@ function TabList({
)[0];
newLanguage.variant = newTabValue;
action.setSelectedVariant(newTabValue.toLowerCase());
} else if (currentLanguage && includeSample) {
newLanguage = languageSet.filter(
(lang) => lang.language === currentLanguage
)[0];
newLanguage.sample = newTabValue;
action.setSelectedSample(newTabValue);
} else {
newLanguage = languageSet.filter(
(lang) => lang.language === newTabValue
)[0];
action.setSelectedVariant(newLanguage.variant.toLowerCase());
}

if (currentLanguage && includeSample) {
newLanguage.sample = newTabValue;
action.setSelectedSample(newTabValue.toLowerCase());
action.setSelectedSample(newLanguage.sample);
}

action.setLanguage(newLanguage);
Expand Down
Loading