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

feat: add method links and scroll to method #21

Merged
merged 3 commits into from
Oct 7, 2023
Merged

feat: add method links and scroll to method #21

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b49b3d1
feat: add janky method link
jcstein Oct 6, 2023
13eeb91
feat: improve but lose link in url bar
jcstein Oct 6, 2023
a97323b
feat: add url hash and scroll to method
jcstein Oct 7, 2023
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
119 changes: 92 additions & 27 deletions src/pages/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import { Bars3BottomLeftIcon, XMarkIcon } from '@heroicons/react/24/outline';
import { ChevronDownIcon, ChevronRightIcon } from '@heroicons/react/24/solid';
import axios from 'axios';
import { Fragment, useEffect, useState } from 'react';
import { useRef } from 'react';
import { CopyToClipboard } from 'react-copy-to-clipboard';
import { FiClipboard } from 'react-icons/fi';
import SyntaxHighlighter from 'react-syntax-highlighter';
Expand Down Expand Up @@ -110,7 +111,8 @@ export default function Example() {
try {
const response = await axios.get(`/specs/openrpc-${version}.json`);
setSpec(response.data);
window.history.replaceState({}, '', `?version=${version}`);
const hash = window.location.hash;
window.history.replaceState({}, '', `?version=${version}${hash}`);
} catch (error) {
// eslint-disable-next-line no-console
console.error('Error fetching JSON data:', error);
Expand All @@ -136,6 +138,23 @@ export default function Example() {
}
}, []);

useEffect(() => {
if (spec) {
setTimeout(() => {
const hash = window.location.hash.substring(1);
const element = document.getElementById(hash);

if (element) {
element.scrollIntoView({
behavior: 'smooth',
block: 'start',
inline: 'nearest',
});
}
}, 1000);
}
}, [spec]);

const activateSidebar = (param: any) => {
setOpen(true);
setCurrentParam(param);
Expand Down Expand Up @@ -507,12 +526,17 @@ export default function Example() {
</h3>
</a>
{filteredMethods.map((method) => (
<RPCMethod
<div
key={`${pkg}.${method.name}`}
pkg={pkg}
method={method}
activateSidebar={activateSidebar}
/>
id={`${pkg}.${method.name}`}
>
<RPCMethod
pkg={pkg}
method={method}
activateSidebar={activateSidebar}
selectedVersion={selectedVersion}
/>
</div>
))}
</div>
);
Expand Down Expand Up @@ -613,43 +637,84 @@ const RPCMethod = ({
pkg,
method,
activateSidebar,
selectedVersion,
}: {
pkg: string;
method: Method;
activateSidebar: (param: Param) => void;
selectedVersion: string;
}) => {
const [showRequest, setShowRequest] = useState(false);
const [showResponse, setShowResponse] = useState(false);
const methodRef = useRef<HTMLDivElement>(null); // create a ref

// const handleCopyClick = () => {
// methodRef.current?.scrollIntoView({
// behavior: 'auto',
// block: 'start',
// inline: 'nearest',
// });
// const newUrl = `${window.location.origin}/?version=${selectedVersion}#${pkg}.${method.name}`;
// window.history.pushState({}, '', newUrl);
// const offset = window.innerWidth >= 768 ? -5 : -70;
// window.scrollBy(0, offset);
// };

const handleCopyClick = () => {
const hash = window.location.hash.substring(1);
const element = document.getElementById(hash);
element?.scrollIntoView();
};

return (
<div key={method.name} className='py-2'>
<p className='text-md'>
{method.name}(
{method.params.map((param, i, { length }) => (
<span key={param.name} className='text-sm text-gray-700'>
<span>{param.name}</span>{' '}
<div
key={`${pkg}.${method.name}`}
id={`${pkg}.${method.name}`}
className='py-2'
ref={methodRef}
>
<div className='flex items-center justify-between'>
<p className='text-md'>
{method.name}(
{method.params.map((param, i, { length }) => (
<span key={param.name} className='text-sm text-gray-700'>
<span>{param.name}</span>{' '}
<span
className='text-blue-500 hover:cursor-pointer hover:font-bold'
onClick={() => activateSidebar(param)}
>
{param.description}
{length - 1 != i && ', '}
</span>
</span>
))}
n )
{method.result.description != 'Null' && (
<span
className='text-blue-500 hover:cursor-pointer hover:font-bold'
onClick={() => activateSidebar(param)}
className='ml-2 text-sm text-blue-500 hover:cursor-pointer hover:font-bold'
onClick={() => activateSidebar(method.result)}
>
{param.description}
{length - 1 != i && ', '}
{method.result.description}
</span>
)}
<span className='ml-2 inline-flex items-center rounded-full bg-purple-100 px-2.5 py-0.5 text-xs font-medium text-purple-800'>
perms: {method.auth}
</span>
))}
)
{method.result.description != 'Null' && (
</p>
<CopyToClipboard
text={`${window.location.origin}/?version=${selectedVersion}#${pkg}.${method.name}`}
onCopy={handleCopyClick}
>
<span
className='ml-2 text-sm text-blue-500 hover:cursor-pointer hover:font-bold'
onClick={() => activateSidebar(method.result)}
className='cursor-pointer text-gray-500 hover:text-blue-500'
onClick={() => {
window.location.hash = `${pkg}.${method.name}`;
}}
>
{method.result.description}
#
</span>
)}
<span className='ml-2 inline-flex items-center rounded-full bg-purple-100 px-2.5 py-0.5 text-xs font-medium text-purple-800'>
perms: {method.auth}
</span>
</p>
</CopyToClipboard>
</div>
<p className='text-sm font-light text-gray-700'>{method.description}</p>
<div className='mt-6 overflow-hidden rounded-lg bg-white text-sm shadow'>
<div
Expand Down
Loading