Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion packages/website/next-env.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
/// <reference types="next/image-types/global" />

// NOTE: This file should not be edited
// see https://nextjs.org/docs/basic-features/typescript for more information.
// see https://nextjs.org/docs/pages/building-your-application/configuring/typescript for more information.
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
const withNextra = require('nextra')({
import nextra from 'nextra';

const withNextra = nextra({
theme: 'nextra-theme-docs',
themeConfig: './src/theme.config.tsx',
});

module.exports = withNextra({
export default withNextra({
webpack: (config) => {
if (!config.resolve.fallback) config.resolve.fallback = {};

Expand Down
9 changes: 4 additions & 5 deletions packages/website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,15 @@
"@codemirror/lang-javascript": "6.2.2",
"@codemirror/lang-json": "6.0.1",
"@codemirror/view": "6.34.1",
"@headlessui/react": "1.7.19",
"@popperjs/core": "2.11.8",
"@headlessui/react": "2.2.0",
"@types/react": "18.3.11",
"@types/react-dom": "18.3.1",
"@uiw/react-codemirror": "4.23.5",
"clsx": "2.1.1",
"next": "14.2.16",
"next-themes": "0.3.0",
"nextra": "2.13.4",
"nextra-theme-docs": "2.13.4",
"next-themes": "0.4.3",
"nextra": "3.2.3",
"nextra-theme-docs": "3.2.3",
"postcss": "8.4.47",
"postcss-lightningcss": "1.0.1",
"react": "18.3.1",
Expand Down
131 changes: 55 additions & 76 deletions packages/website/src/components/Select.tsx
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
import type { ReactElement, ReactNode } from 'react';
import {
Listbox,
ListboxButton,
ListboxOption,
ListboxOptions,
} from '@headlessui/react';
import cn from 'clsx';
import { Listbox, Transition } from '@headlessui/react';
import { CheckIcon } from 'nextra/icons';
import { usePopper } from '../utils/usePopper';
import { createPortal } from 'react-dom';
import { useMounted } from 'nextra/hooks';
import type { ReactElement } from 'react';

interface MenuOption {
key: string;
Expand All @@ -26,82 +28,59 @@ export function Select({
title,
className,
}: MenuProps): ReactElement {
const [trigger, container] = usePopper({
strategy: 'fixed',
placement: 'top-start',
modifiers: [
{ name: 'offset', options: { offset: [0, 10] } },
{
name: 'sameWidth',
enabled: true,
fn({ state }) {
state.styles.popper.minWidth = `${state.rects.reference.width}px`;
},
phase: 'beforeWrite',
requires: ['computeStyles'],
},
],
});

return (
<Listbox value={selected} onChange={onChange}>
{({ open }) => (
<Listbox.Button
ref={trigger}
title={title}
className={cn(
'h-7 rounded-md px-2 text-left text-xs font-medium text-gray-600 transition-colors dark:text-gray-400',
<ListboxButton
title={title}
className={({ hover, open, focus }) =>
cn(
'h-7 rounded-md px-2 text-xs font-medium transition-colors',
open
? 'dark:bg-primary-100/10 bg-gray-200 text-gray-900 dark:text-gray-50'
: 'dark:hover:bg-primary-100/5 hover:bg-gray-100 hover:text-gray-900 dark:hover:text-gray-50',
: hover
? 'dark:bg-primary-100/5 bg-gray-100 text-gray-900 dark:text-gray-50'
: 'text-gray-600 dark:text-gray-400',
focus && 'nextra-focusable',
className,
)}
>
{selected.name}
<Portal>
<Transition
ref={container}
show={open}
as={Listbox.Options}
className="z-20 max-h-64 overflow-auto rounded-md bg-white py-1 text-sm shadow-lg ring-1 ring-black/5 dark:bg-neutral-800 dark:ring-white/20"
leave="transition-opacity"
leaveFrom="opacity-100"
leaveTo="opacity-0"
>
{options.map((option) => (
<Listbox.Option
key={option.key}
value={option}
className={({ active }) =>
cn(
active
? 'bg-primary-50 text-primary-600 dark:bg-primary-500/10'
: 'text-gray-800 dark:text-gray-100',
'relative cursor-pointer whitespace-nowrap py-1.5',
'transition-colors ltr:pl-3 ltr:pr-9 rtl:pl-9 rtl:pr-3',
)
}
>
{option.name}
{option.key === selected.key && (
<span className="absolute inset-y-0 flex items-center ltr:right-3 rtl:left-3">
<CheckIcon />
</span>
)}
</Listbox.Option>
))}
</Transition>
</Portal>
</Listbox.Button>
)}
)
}
>
{selected.name}
</ListboxButton>
<ListboxOptions
as="ul"
transition
anchor={{ to: 'top start', gap: 10 }}
className={({ open }) =>
cn(
'nextra-focus',
open ? 'opacity-100' : 'opacity-0',
'z-20 max-h-64 min-w-[--button-width] rounded-md border border-black/5 bg-[rgb(var(--nextra-bg),.8)] py-1 text-sm shadow-lg backdrop-blur-lg transition-opacity motion-reduce:transition-none dark:border-white/20',
)
}
>
{options.map((option) => (
<ListboxOption
key={option.key}
value={option}
as="li"
className={({ focus }) =>
cn(
focus
? 'bg-primary-50 text-primary-600 dark:bg-primary-500/10'
: 'text-gray-800 dark:text-gray-100',
'cursor-pointer whitespace-nowrap px-3 py-1.5',
'transition-colors',
option.key === selected.key &&
'flex items-center justify-between gap-3',
)
}
>
{option.name}
{option.key === selected.key && <CheckIcon height="16" />}
</ListboxOption>
))}
</ListboxOptions>
</Listbox>
);
}

function Portal(props: { children: ReactNode }): ReactElement | null {
const mounted = useMounted();

if (!mounted) return null;

return createPortal(props.children, document.body);
}
5 changes: 0 additions & 5 deletions packages/website/src/pages/_app.mdx

This file was deleted.

6 changes: 6 additions & 0 deletions packages/website/src/pages/_app.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import './globals.css';
import type { AppProps } from 'next/app';

export default function App({ Component, pageProps }: AppProps) {
return <Component {...pageProps} />;
}
31 changes: 31 additions & 0 deletions packages/website/src/pages/_meta.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
export default {
index: {
title: 'Home',
type: 'page',
},
docs: {
title: 'Docs',
type: 'page',
},
playground: {
title: 'Playground',
type: 'page',
theme: {
layout: 'raw',
},
},
users: {
title: 'Users',
type: 'page',
theme: {
typesetting: 'article',
},
},
about: {
title: 'About',
type: 'page',
theme: {
typesetting: 'article',
},
},
};
31 changes: 0 additions & 31 deletions packages/website/src/pages/_meta.json

This file was deleted.

3 changes: 3 additions & 0 deletions packages/website/src/pages/about.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: 'About'
---
# About react-docgen

react-docgen was initially created by [Facebook](https://www.facebook.com) member
Expand Down
7 changes: 7 additions & 0 deletions packages/website/src/pages/docs/_meta.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export default {
'getting-started': 'Getting started',
extending: 'Extending',
reference: 'Reference',
migrate: 'Migrate',
'release-notes': 'Release Notes',
};
7 changes: 0 additions & 7 deletions packages/website/src/pages/docs/_meta.json

This file was deleted.

6 changes: 6 additions & 0 deletions packages/website/src/pages/docs/extending/_meta.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
export default {
architecture: 'Architecture',
resolver: 'Resolver',
handler: 'Handler',
importer: 'Importer',
};
6 changes: 0 additions & 6 deletions packages/website/src/pages/docs/extending/_meta.json

This file was deleted.

4 changes: 4 additions & 0 deletions packages/website/src/pages/docs/getting-started/_meta.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
export default {
nodejs: 'Node.js',
cli: 'CLI',
};
4 changes: 0 additions & 4 deletions packages/website/src/pages/docs/getting-started/_meta.json

This file was deleted.

26 changes: 13 additions & 13 deletions packages/website/src/pages/docs/getting-started/cli.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Tab, Tabs } from 'nextra-theme-docs';
import { Tabs } from 'nextra/components';

# Getting started with the Command Line Interface (CLI)

Expand All @@ -12,55 +12,55 @@ a dependency.
In order to use it directly any of these commands will work:

<Tabs items={["npx", "pnpm", "yarn"]}>
<Tab>
<Tabs.Tab>

```shell filename="Terminal" copy
npx @react-docgen/cli --help
```

</Tab>
<Tab>
</Tabs.Tab>
<Tabs.Tab>

```shell filename="Terminal" copy
pnpm dlx @react-docgen/cli --help
```

</Tab>
<Tab>
</Tabs.Tab>
<Tabs.Tab>

```shell filename="Terminal" copy
yarn dlx @react-docgen/cli --help
```

</Tab>
</Tabs.Tab>
</Tabs>

### Install

Installing the CLI can be done with any available package manager:

<Tabs items={["npm", "pnpm", "yarn"]}>
<Tab>
<Tabs.Tab>

```shell filename="Terminal" copy
npm install --save @react-docgen/cli
```

</Tab>
<Tab>
</Tabs.Tab>
<Tabs.Tab>

```shell filename="Terminal" copy
pnpm add @react-docgen/cli
```

</Tab>
<Tab>
</Tabs.Tab>
<Tabs.Tab>

```shell filename="Terminal" copy
yarn add @react-docgen/cli
```

</Tab>
</Tabs.Tab>
</Tabs>

## Usage
Expand Down
Loading
Loading