Compare commits
74 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ad57674d6e | ||
|
|
065bec9a37 | ||
|
|
d3ccafc6d5 | ||
|
|
c71d70bbb4 | ||
|
|
5ba12af699 | ||
|
|
ff39ef753f | ||
|
|
2288c27e1e | ||
|
|
c86648f44e | ||
|
|
0edf702b5f | ||
|
|
05bda71ad6 | ||
|
|
0217fb8533 | ||
|
|
b59dcc0ae7 | ||
|
|
3efaef162b | ||
|
|
4c2aafe185 | ||
|
|
d3d1f473ae | ||
|
|
116e606db1 | ||
|
|
490bf2cefa | ||
|
|
e06bfa490f | ||
|
|
2765b4fda4 | ||
|
|
5660297588 | ||
|
|
2cdd324495 | ||
|
|
7a09e8fdca | ||
|
|
8111931183 | ||
|
|
fd64132e58 | ||
|
|
1ba0da6c86 | ||
|
|
fdd6a3a3cc | ||
|
|
8ce3834cf4 | ||
|
|
1bfbe9608c | ||
|
|
0695bbc6bd | ||
|
|
569e5c7473 | ||
|
|
62300d23ca | ||
|
|
cda69a0c85 | ||
|
|
785384286b | ||
|
|
50961e888e | ||
|
|
8c3304144e | ||
|
|
b6b05232f7 | ||
|
|
33a170a4fb | ||
|
|
9a6f85a726 | ||
|
|
a79649048f | ||
|
|
e7196e686c | ||
|
|
26eb8bedb0 | ||
|
|
2851d4b787 | ||
|
|
46d3c64133 | ||
|
|
6b77971ed5 | ||
|
|
effd16ed97 | ||
|
|
989ab330b3 | ||
|
|
0aafc66ce1 | ||
|
|
ff8347b52a | ||
|
|
c436500b3a | ||
|
|
e93506409f | ||
|
|
8482f6e91a | ||
|
|
c5e11b4417 | ||
|
|
2e4ff0f524 | ||
|
|
d0c940c693 | ||
|
|
01f245c2e2 | ||
|
|
b65004dd75 | ||
|
|
d9dd4d5307 | ||
|
|
2b3b8953d0 | ||
|
|
a6b706a3de | ||
|
|
d3f6c8af4d | ||
|
|
b0e937f896 | ||
|
|
8b371cd1cf | ||
|
|
ba155226f1 | ||
|
|
a1424f4607 | ||
|
|
42461c7ec8 | ||
|
|
27f793b1db | ||
|
|
97a5526d9d | ||
|
|
99eebef9a9 | ||
|
|
1b97f9256f | ||
|
|
1a04e6093d | ||
|
|
4803cb8478 | ||
|
|
4201f45cc9 | ||
|
|
52b83522de | ||
|
|
017a417773 |
@@ -17,9 +17,9 @@
|
||||
},
|
||||
"overrides": [
|
||||
{
|
||||
"files": ["packages/docs/cypress/**"],
|
||||
"files": ["packages/website/cypress/**"],
|
||||
"parserOptions": {
|
||||
"project": "./packages/docs/cypress/tsconfig.json"
|
||||
"project": "./packages/website/cypress/tsconfig.json"
|
||||
}
|
||||
}
|
||||
]
|
||||
|
||||
18
.github/workflows/deploy-docs.yml
vendored
@@ -1,18 +0,0 @@
|
||||
name: deploy docs
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
paths:
|
||||
- "packages/docs/**"
|
||||
- "reacord/library/**/*.{ts,tsx}"
|
||||
|
||||
jobs:
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: superfly/flyctl-actions@master
|
||||
env:
|
||||
FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }}
|
||||
with:
|
||||
args: "deploy"
|
||||
30
.github/workflows/main.yml
vendored
@@ -11,20 +11,24 @@ env:
|
||||
TEST_GUILD_ID: ${{ secrets.TEST_GUILD_ID }}
|
||||
|
||||
jobs:
|
||||
run-scripts:
|
||||
run-commands:
|
||||
strategy:
|
||||
matrix:
|
||||
scripts:
|
||||
- name: test
|
||||
script: coverage
|
||||
- name: lint
|
||||
script: lint
|
||||
- name: typecheck
|
||||
script: typecheck
|
||||
- name: build
|
||||
script: build
|
||||
fail-fast: false
|
||||
name: ${{ matrix.scripts.name }}
|
||||
matrix:
|
||||
command:
|
||||
# if these run in the same process, it dies,
|
||||
# so we test them separate
|
||||
- name: test reacord
|
||||
run: pnpm test -C packages/reacord
|
||||
- name: test website
|
||||
run: pnpm test -C packages/website
|
||||
- name: build
|
||||
run: pnpm build --recursive
|
||||
- name: lint
|
||||
run: pnpm lint
|
||||
- name: typecheck
|
||||
run: pnpm typecheck --parallel
|
||||
name: ${{ matrix.command.name }}
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
@@ -34,4 +38,4 @@ jobs:
|
||||
node-version: "16"
|
||||
- run: npm i -g pnpm
|
||||
- run: pnpm install --frozen-lockfile
|
||||
- run: pnpm run --recursive ${{ matrix.scripts.script }}
|
||||
- run: ${{ matrix.command.run }}
|
||||
|
||||
@@ -9,7 +9,7 @@ RUN ls -R
|
||||
|
||||
RUN npm install -g pnpm
|
||||
RUN pnpm install --unsafe-perm --frozen-lockfile
|
||||
RUN pnpm run build -C packages/docs
|
||||
RUN pnpm run build -C packages/website
|
||||
|
||||
ENV NODE_ENV=production
|
||||
CMD [ "pnpm", "-C", "packages/docs", "start" ]
|
||||
CMD [ "pnpm", "-C", "packages/website", "start" ]
|
||||
|
||||
12
README.md
@@ -1,7 +1,9 @@
|
||||
# reacord
|
||||
Create interactive Discord messages using React!
|
||||
<center>
|
||||
<img src="./packages/website/app/assets/banner.png" alt="Reacord: Create interactive Discord messages using React">
|
||||
</center>
|
||||
|
||||
## Installation ∙ [](https://www.npmjs.com/package/reacord)
|
||||
|
||||
## Installation
|
||||
```console
|
||||
# npm
|
||||
npm install reacord react discord.js
|
||||
@@ -15,9 +17,11 @@ pnpm add reacord react discord.js
|
||||
```
|
||||
|
||||
## Get Started
|
||||
[Visit the docs to get started.](https://reacord.fly.dev/guides/getting-started)
|
||||
|
||||
[Visit the docs to get started.](https://reacord.mapleleaf.dev/guides/getting-started)
|
||||
|
||||
## Example
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
```tsx
|
||||
import * as React from "react"
|
||||
|
||||
40
fly.toml
@@ -1,40 +0,0 @@
|
||||
# fly.toml file generated for reacord on 2021-12-29T14:06:41-06:00
|
||||
|
||||
app = "reacord"
|
||||
|
||||
kill_signal = "SIGINT"
|
||||
kill_timeout = 5
|
||||
processes = []
|
||||
|
||||
[env]
|
||||
PORT = 8080
|
||||
|
||||
[experimental]
|
||||
allowed_public_ports = []
|
||||
auto_rollback = true
|
||||
|
||||
[[services]]
|
||||
http_checks = []
|
||||
internal_port = 8080
|
||||
processes = ["app"]
|
||||
protocol = "tcp"
|
||||
script_checks = []
|
||||
|
||||
[services.concurrency]
|
||||
hard_limit = 25
|
||||
soft_limit = 20
|
||||
type = "connections"
|
||||
|
||||
[[services.ports]]
|
||||
handlers = ["http"]
|
||||
port = 80
|
||||
|
||||
[[services.ports]]
|
||||
handlers = ["tls", "http"]
|
||||
port = 443
|
||||
|
||||
[[services.tcp_checks]]
|
||||
grace_period = "1s"
|
||||
interval = "15s"
|
||||
restart_limit = 0
|
||||
timeout = "2s"
|
||||
@@ -9,8 +9,8 @@
|
||||
"@itsmapleleaf/configs": "^1.1.2"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@typescript-eslint/eslint-plugin": "^5.9.0",
|
||||
"@typescript-eslint/parser": "^5.9.0",
|
||||
"@typescript-eslint/eslint-plugin": "^5.9.1",
|
||||
"@typescript-eslint/parser": "^5.9.1",
|
||||
"eslint": "^8.6.0",
|
||||
"eslint-config-prettier": "^8.3.0",
|
||||
"eslint-import-resolver-typescript": "^2.5.0",
|
||||
@@ -18,7 +18,7 @@
|
||||
"eslint-plugin-jsx-a11y": "^6.5.1",
|
||||
"eslint-plugin-react": "^7.28.0",
|
||||
"eslint-plugin-react-hooks": "^4.3.0",
|
||||
"eslint-plugin-unicorn": "^39.0.0",
|
||||
"eslint-plugin-unicorn": "^40.0.0",
|
||||
"prettier": "^2.5.1",
|
||||
"typescript": "^4.5.4"
|
||||
},
|
||||
|
||||
@@ -1,19 +0,0 @@
|
||||
{/* prettier-ignore */}
|
||||
```tsx
|
||||
import * as React from "react"
|
||||
import { Embed, Button } from "reacord"
|
||||
|
||||
function Counter() {
|
||||
const [count, setCount] = React.useState(0)
|
||||
return (
|
||||
<>
|
||||
<Embed title="Counter">
|
||||
This button has been clicked {count} times.
|
||||
</Embed>
|
||||
<Button onClick={() => setCount(count + 1)}>
|
||||
+1
|
||||
</Button>
|
||||
</>
|
||||
)
|
||||
}
|
||||
```
|
||||
@@ -1,42 +0,0 @@
|
||||
import { useGuideLinksContext } from "~/modules/navigation/guide-links-context"
|
||||
import { linkClass } from "../ui/components"
|
||||
import { PopoverMenu } from "../ui/popover-menu"
|
||||
import { AppLink } from "./app-link"
|
||||
import { mainLinks } from "./main-links"
|
||||
|
||||
export function MainNavigation() {
|
||||
const guideLinks = useGuideLinksContext()
|
||||
return (
|
||||
<nav className="flex justify-between items-center h-16">
|
||||
<a href="/">
|
||||
<h1 className="text-3xl font-light">reacord</h1>
|
||||
</a>
|
||||
<div className="hidden md:flex gap-4">
|
||||
{mainLinks.map((link) => (
|
||||
<AppLink {...link} key={link.to} className={linkClass} />
|
||||
))}
|
||||
</div>
|
||||
<div className="md:hidden">
|
||||
<PopoverMenu>
|
||||
{mainLinks.map((link) => (
|
||||
<AppLink
|
||||
{...link}
|
||||
role="menuitem"
|
||||
key={link.to}
|
||||
className={PopoverMenu.itemClass}
|
||||
/>
|
||||
))}
|
||||
<hr className="border-0 h-[2px] bg-black/50" />
|
||||
{guideLinks.map(({ link }) => (
|
||||
<AppLink
|
||||
{...link}
|
||||
role="menuitem"
|
||||
key={link.to}
|
||||
className={PopoverMenu.itemClass}
|
||||
/>
|
||||
))}
|
||||
</PopoverMenu>
|
||||
</div>
|
||||
</nav>
|
||||
)
|
||||
}
|
||||
@@ -1,24 +0,0 @@
|
||||
import clsx from "clsx"
|
||||
|
||||
export const maxWidthContainer = clsx`mx-auto w-full max-w-screen-lg px-4`
|
||||
|
||||
export const inlineIconClass = clsx`inline w-5 align-sub`
|
||||
|
||||
export const linkClass = clsx`
|
||||
font-medium inline-block relative
|
||||
opacity-60 hover:opacity-100 transition-opacity
|
||||
after:absolute after:block after:w-full after:h-px after:bg-white/50 after:translate-y-[3px] after:opacity-0 after:transition
|
||||
hover:after:translate-y-[-1px] hover:after:opacity-100
|
||||
`
|
||||
|
||||
export const docsProseClass = clsx`
|
||||
prose prose-invert
|
||||
prose-h1:font-light prose-h1:mb-4 prose-h1:text-3xl lg:prose-h1:text-4xl
|
||||
prose-h2:font-light
|
||||
prose-h3:font-light
|
||||
prose-p:my-4
|
||||
prose-a:font-medium prose-a:text-emerald-400 hover:prose-a:no-underline
|
||||
prose-strong:font-medium prose-strong:text-emerald-400
|
||||
prose-pre:font-monospace prose-pre:overflow-x-auto
|
||||
max-w-none
|
||||
`
|
||||
@@ -1,32 +0,0 @@
|
||||
import { MenuAlt4Icon } from "@heroicons/react/outline"
|
||||
import clsx from "clsx"
|
||||
import React from "react"
|
||||
import { linkClass } from "./components"
|
||||
|
||||
export function PopoverMenu({ children }: { children: React.ReactNode }) {
|
||||
return (
|
||||
<div className="relative" x-data="{ open: false }">
|
||||
<button title="Menu" className={linkClass} x-on:click="open = !open">
|
||||
<MenuAlt4Icon className="w-6" />
|
||||
</button>
|
||||
<div
|
||||
role="menu"
|
||||
className={`
|
||||
w-48 max-h-[calc(100vh-4rem)]
|
||||
absolute right-0 top-[calc(100%+8px)]
|
||||
bg-slate-800 shadow rounded-lg
|
||||
overflow-hidden overflow-y-auto
|
||||
transition-all
|
||||
`}
|
||||
x-bind:class="open ? 'visible opacity-100' : 'invisible opacity-0 translate-y-3'"
|
||||
>
|
||||
{children}
|
||||
</div>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
|
||||
PopoverMenu.itemClass = clsx`
|
||||
px-3 py-2 transition text-left font-medium block
|
||||
opacity-50 hover:opacity-100 hover:bg-black/30
|
||||
`
|
||||
@@ -1,29 +0,0 @@
|
||||
import packageJson from "reacord/package.json"
|
||||
import LandingExample from "~/modules/landing/landing-example.mdx"
|
||||
import { MainNavigation } from "~/modules/navigation/main-navigation"
|
||||
import { maxWidthContainer } from "~/modules/ui/components"
|
||||
|
||||
export default function Landing() {
|
||||
return (
|
||||
<div className="flex flex-col min-w-0 min-h-screen text-center">
|
||||
<header className={maxWidthContainer}>
|
||||
<MainNavigation />
|
||||
</header>
|
||||
<div className="px-4 pb-8 flex flex-1">
|
||||
<main className="px-4 py-6 rounded-lg shadow bg-slate-800 space-y-5 m-auto w-full max-w-xl">
|
||||
<h1 className="text-6xl font-light">reacord</h1>
|
||||
<section className="mx-auto text-sm sm:text-base">
|
||||
<LandingExample />
|
||||
</section>
|
||||
<p className="text-2xl font-light">{packageJson.description}</p>
|
||||
<a
|
||||
href="/guides/getting-started"
|
||||
className="inline-block px-4 py-3 text-xl transition rounded-lg bg-emerald-700 hover:translate-y-[-2px] hover:bg-emerald-800 hover:shadow"
|
||||
>
|
||||
Get Started
|
||||
</a>
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
@@ -1,5 +0,0 @@
|
||||
import type { LoaderFunction } from "remix"
|
||||
import { serveTailwindCss } from "remix-tailwind"
|
||||
|
||||
export const loader: LoaderFunction = () =>
|
||||
serveTailwindCss("app/modules/ui/tailwind.css")
|
||||
|
Before Width: | Height: | Size: 17 KiB |
2
packages/reacord/.gitignore
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
/README.md
|
||||
/LICENSE
|
||||
@@ -2,6 +2,7 @@ import type {
|
||||
CamelCasedPropertiesDeep,
|
||||
SnakeCasedPropertiesDeep,
|
||||
} from "type-fest"
|
||||
import { expect, test } from "vitest"
|
||||
import { camelCaseDeep, snakeCaseDeep } from "./convert-object-property-case"
|
||||
|
||||
test("camelCaseDeep", () => {
|
||||
@@ -12,12 +13,14 @@ test("camelCaseDeep", () => {
|
||||
someOtherProp: "someOtherValue",
|
||||
}
|
||||
|
||||
expect(camelCaseDeep(input)).toEqual<CamelCasedPropertiesDeep<typeof input>>({
|
||||
const expected: CamelCasedPropertiesDeep<typeof input> = {
|
||||
someProp: {
|
||||
someDeepProp: "some_deep_value",
|
||||
},
|
||||
someOtherProp: "someOtherValue",
|
||||
})
|
||||
}
|
||||
|
||||
expect(camelCaseDeep(input)).toEqual(expected)
|
||||
})
|
||||
|
||||
test("snakeCaseDeep", () => {
|
||||
@@ -28,10 +31,12 @@ test("snakeCaseDeep", () => {
|
||||
some_other_prop: "someOtherValue",
|
||||
}
|
||||
|
||||
expect(snakeCaseDeep(input)).toEqual<SnakeCasedPropertiesDeep<typeof input>>({
|
||||
const expected: SnakeCasedPropertiesDeep<typeof input> = {
|
||||
some_prop: {
|
||||
some_deep_prop: "someDeepValue",
|
||||
},
|
||||
some_other_prop: "someOtherValue",
|
||||
})
|
||||
}
|
||||
|
||||
expect(snakeCaseDeep(input)).toEqual(expected)
|
||||
})
|
||||
|
||||
7
packages/reacord/helpers/is-object.ts
Normal file
@@ -0,0 +1,7 @@
|
||||
export function isObject<T>(
|
||||
value: T,
|
||||
): value is Exclude<T, Primitive | AnyFunction> {
|
||||
return typeof value === "object" && value !== null
|
||||
}
|
||||
type Primitive = string | number | boolean | undefined | null
|
||||
type AnyFunction = (...args: any[]) => any
|
||||
@@ -1,15 +0,0 @@
|
||||
export function pruneNullishValues<T extends object>(
|
||||
object: T,
|
||||
): PruneNullishValues<T> {
|
||||
const result: any = {}
|
||||
for (const [key, value] of Object.entries(object)) {
|
||||
if (value != undefined) {
|
||||
result[key] = value
|
||||
}
|
||||
}
|
||||
return result
|
||||
}
|
||||
|
||||
type PruneNullishValues<T> = {
|
||||
[Key in keyof T]: NonNullable<T[Key]>
|
||||
}
|
||||
27
packages/reacord/helpers/prune-nullish-values.ts
Normal file
@@ -0,0 +1,27 @@
|
||||
import { isObject } from "./is-object"
|
||||
|
||||
export function pruneNullishValues<T>(input: T): PruneNullishValues<T> {
|
||||
if (Array.isArray(input)) {
|
||||
return input.filter(Boolean).map((item) => pruneNullishValues(item)) as any
|
||||
}
|
||||
|
||||
if (!isObject(input)) {
|
||||
return input as any
|
||||
}
|
||||
|
||||
const result: any = {}
|
||||
for (const [key, value] of Object.entries(input)) {
|
||||
if (value != undefined) {
|
||||
result[key] = pruneNullishValues(value)
|
||||
}
|
||||
}
|
||||
return result
|
||||
}
|
||||
|
||||
type PruneNullishValues<Input> = Input extends ReadonlyArray<infer Value>
|
||||
? ReadonlyArray<NonNullable<Value>>
|
||||
: Input extends object
|
||||
? {
|
||||
[Key in keyof Input]: NonNullable<Input[Key]>
|
||||
}
|
||||
: Input
|
||||
@@ -6,5 +6,5 @@ export async function rejectAfter(
|
||||
error: unknown = `rejected after ${timeMs}ms`,
|
||||
): Promise<never> {
|
||||
await setTimeout(timeMs)
|
||||
return Promise.reject(toError(error))
|
||||
throw toError(error)
|
||||
}
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
/** @type {import('@jest/types').Config.InitialOptions} */
|
||||
const config = {
|
||||
transform: {
|
||||
"^.+\\.[jt]sx?$": ["esbuild-jest", { format: "esm", sourcemap: true }],
|
||||
},
|
||||
extensionsToTreatAsEsm: [".ts", ".tsx"],
|
||||
moduleNameMapper: {
|
||||
"^(\\.\\.?/.+)\\.jsx?$": "$1",
|
||||
},
|
||||
verbose: true,
|
||||
cache: false,
|
||||
coverageReporters: ["text", "text-summary", "html"],
|
||||
coveragePathIgnorePatterns: ["discord-js-adapter", "test/setup-testing"],
|
||||
}
|
||||
export default config
|
||||
@@ -21,9 +21,9 @@ export type ActionRowProps = {
|
||||
* ```tsx
|
||||
* // put buttons on two separate rows
|
||||
* <ActionRow>
|
||||
* <Button onClick={handleFirst}>First</Button>
|
||||
* <Button label="First" onClick={handleFirst} />
|
||||
* </ActionRow>
|
||||
* <Button onClick={handleSecond}>Second</Button>
|
||||
* <Button label="Second" onClick={handleSecond} />
|
||||
* ```
|
||||
*
|
||||
* @category Action Row
|
||||
|
||||
@@ -4,7 +4,11 @@ import React from "react"
|
||||
import { isInstanceOf } from "../../../helpers/is-instance-of"
|
||||
import { ReacordElement } from "../../internal/element.js"
|
||||
import type { ComponentInteraction } from "../../internal/interaction"
|
||||
import type { ActionRow, MessageOptions } from "../../internal/message"
|
||||
import type {
|
||||
ActionRow,
|
||||
ActionRowItem,
|
||||
MessageOptions,
|
||||
} from "../../internal/message"
|
||||
import { Node } from "../../internal/node.js"
|
||||
import type { ComponentEvent } from "../component-event"
|
||||
import { OptionNode } from "./option-node"
|
||||
@@ -108,19 +112,25 @@ class SelectNode extends Node<SelectProps> {
|
||||
...props
|
||||
} = this.props
|
||||
|
||||
actionRow.push({
|
||||
const item: ActionRowItem = {
|
||||
...props,
|
||||
type: "select",
|
||||
customId: this.customId,
|
||||
options,
|
||||
// I'm not counting on people using value and values at the same time,
|
||||
// but maybe we should resolve this differently anyhow? e.g. one should override the other
|
||||
// or just warn if there are both
|
||||
// or... try some other alternative design entirely
|
||||
values: [...(values || []), ...(value ? [value] : [])],
|
||||
minValues: multiple ? minValues : undefined,
|
||||
maxValues: multiple ? Math.max(minValues, maxValues) : undefined,
|
||||
})
|
||||
values: [],
|
||||
}
|
||||
|
||||
if (multiple) {
|
||||
item.minValues = minValues
|
||||
item.maxValues = maxValues
|
||||
if (values) item.values = values
|
||||
}
|
||||
|
||||
if (!multiple && value != undefined) {
|
||||
item.values = [value]
|
||||
}
|
||||
|
||||
actionRow.push(item)
|
||||
}
|
||||
|
||||
override handleComponentInteraction(
|
||||
|
||||
20
packages/reacord/library/core/instance-context.tsx
Normal file
@@ -0,0 +1,20 @@
|
||||
import * as React from "react"
|
||||
import { raise } from "../../helpers/raise"
|
||||
import type { ReacordInstance } from "./instance"
|
||||
|
||||
const Context = React.createContext<ReacordInstance | undefined>(undefined)
|
||||
|
||||
export const InstanceProvider = Context.Provider
|
||||
|
||||
/**
|
||||
* Get the associated instance for the current component.
|
||||
*
|
||||
* @category Core
|
||||
* @see https://reacord.mapleleaf.dev/guides/use-instance
|
||||
*/
|
||||
export function useInstance(): ReacordInstance {
|
||||
return (
|
||||
React.useContext(Context) ??
|
||||
raise("Could not find instance, was this component rendered via Reacord?")
|
||||
)
|
||||
}
|
||||
@@ -3,7 +3,7 @@ import * as Discord from "discord.js"
|
||||
import type { ReactNode } from "react"
|
||||
import type { Except } from "type-fest"
|
||||
import { pick } from "../../helpers/pick"
|
||||
import { pruneNullishValues } from "../../helpers/prune-null-values"
|
||||
import { pruneNullishValues } from "../../helpers/prune-nullish-values"
|
||||
import { raise } from "../../helpers/raise"
|
||||
import { toUpper } from "../../helpers/to-upper"
|
||||
import type { ComponentInteraction } from "../internal/interaction"
|
||||
@@ -40,7 +40,7 @@ export class ReacordDiscordJs extends Reacord {
|
||||
|
||||
/**
|
||||
* Sends a message to a channel.
|
||||
* @see https://reacord.fly.dev/guides/sending-messages
|
||||
* @see https://reacord.mapleleaf.dev/guides/sending-messages
|
||||
*/
|
||||
override send(
|
||||
channelId: string,
|
||||
@@ -54,7 +54,7 @@ export class ReacordDiscordJs extends Reacord {
|
||||
|
||||
/**
|
||||
* Sends a message as a reply to a command interaction.
|
||||
* @see https://reacord.fly.dev/guides/sending-messages
|
||||
* @see https://reacord.mapleleaf.dev/guides/sending-messages
|
||||
*/
|
||||
override reply(
|
||||
interaction: Discord.CommandInteraction,
|
||||
@@ -68,7 +68,7 @@ export class ReacordDiscordJs extends Reacord {
|
||||
|
||||
/**
|
||||
* Sends an ephemeral message as a reply to a command interaction.
|
||||
* @see https://reacord.fly.dev/guides/sending-messages
|
||||
* @see https://reacord.mapleleaf.dev/guides/sending-messages
|
||||
*/
|
||||
override ephemeralReply(
|
||||
interaction: Discord.CommandInteraction,
|
||||
@@ -154,14 +154,16 @@ export class ReacordDiscordJs extends Reacord {
|
||||
// todo please dear god clean this up
|
||||
const channel: ChannelInfo = interaction.channel
|
||||
? {
|
||||
...pick(pruneNullishValues(interaction.channel), [
|
||||
"topic",
|
||||
"nsfw",
|
||||
"lastMessageId",
|
||||
"ownerId",
|
||||
"parentId",
|
||||
"rateLimitPerUser",
|
||||
]),
|
||||
...pruneNullishValues(
|
||||
pick(interaction.channel, [
|
||||
"topic",
|
||||
"nsfw",
|
||||
"lastMessageId",
|
||||
"ownerId",
|
||||
"parentId",
|
||||
"rateLimitPerUser",
|
||||
]),
|
||||
),
|
||||
id: interaction.channelId,
|
||||
}
|
||||
: raise("Non-channel interactions are not supported")
|
||||
@@ -190,15 +192,17 @@ export class ReacordDiscordJs extends Reacord {
|
||||
const member: GuildMemberInfo | undefined =
|
||||
interaction.member instanceof Discord.GuildMember
|
||||
? {
|
||||
...pick(pruneNullishValues(interaction.member), [
|
||||
"id",
|
||||
"nick",
|
||||
"displayName",
|
||||
"avatarUrl",
|
||||
"displayAvatarUrl",
|
||||
"color",
|
||||
"pending",
|
||||
]),
|
||||
...pruneNullishValues(
|
||||
pick(interaction.member, [
|
||||
"id",
|
||||
"nick",
|
||||
"displayName",
|
||||
"avatarUrl",
|
||||
"displayAvatarUrl",
|
||||
"color",
|
||||
"pending",
|
||||
]),
|
||||
),
|
||||
displayName: interaction.member.displayName,
|
||||
roles: [...interaction.member.roles.cache.map((role) => role.id)],
|
||||
joinedAt: interaction.member.joinedAt?.toISOString(),
|
||||
@@ -210,18 +214,15 @@ export class ReacordDiscordJs extends Reacord {
|
||||
|
||||
const guild: GuildInfo | undefined = interaction.guild
|
||||
? {
|
||||
...pick(pruneNullishValues(interaction.guild), ["id", "name"]),
|
||||
...pruneNullishValues(pick(interaction.guild, ["id", "name"])),
|
||||
member: member ?? raise("unexpected: member is undefined"),
|
||||
}
|
||||
: undefined
|
||||
|
||||
const user: UserInfo = {
|
||||
...pick(pruneNullishValues(interaction.user), [
|
||||
"id",
|
||||
"username",
|
||||
"discriminator",
|
||||
"tag",
|
||||
]),
|
||||
...pruneNullishValues(
|
||||
pick(interaction.user, ["id", "username", "discriminator", "tag"]),
|
||||
),
|
||||
avatarUrl: interaction.user.avatarURL()!,
|
||||
accentColor: interaction.user.accentColor ?? undefined,
|
||||
}
|
||||
|
||||
@@ -1,8 +1,10 @@
|
||||
import type { ReactNode } from "react"
|
||||
import React from "react"
|
||||
import type { ComponentInteraction } from "../internal/interaction"
|
||||
import { reconciler } from "../internal/reconciler.js"
|
||||
import type { Renderer } from "../internal/renderers/renderer"
|
||||
import type { ReacordInstance } from "./instance"
|
||||
import { InstanceProvider } from "./instance-context"
|
||||
|
||||
/**
|
||||
* @category Core
|
||||
@@ -47,13 +49,12 @@ export abstract class Reacord {
|
||||
|
||||
const container = reconciler.createContainer(renderer, 0, false, {})
|
||||
|
||||
if (initialContent !== undefined) {
|
||||
reconciler.updateContainer(initialContent, container)
|
||||
}
|
||||
|
||||
return {
|
||||
const instance: ReacordInstance = {
|
||||
render: (content: ReactNode) => {
|
||||
reconciler.updateContainer(content, container)
|
||||
reconciler.updateContainer(
|
||||
<InstanceProvider value={instance}>{content}</InstanceProvider>,
|
||||
container,
|
||||
)
|
||||
},
|
||||
deactivate: () => {
|
||||
this.deactivate(renderer)
|
||||
@@ -63,6 +64,12 @@ export abstract class Reacord {
|
||||
renderer.destroy()
|
||||
},
|
||||
}
|
||||
|
||||
if (initialContent !== undefined) {
|
||||
instance.render(initialContent)
|
||||
}
|
||||
|
||||
return instance
|
||||
}
|
||||
|
||||
private deactivate(renderer: Renderer) {
|
||||
@@ -9,9 +9,12 @@ export type MessageOptions = {
|
||||
actionRows: ActionRow[]
|
||||
}
|
||||
|
||||
export type ActionRow = Array<
|
||||
MessageButtonOptions | MessageLinkOptions | MessageSelectOptions
|
||||
>
|
||||
export type ActionRow = ActionRowItem[]
|
||||
|
||||
export type ActionRowItem =
|
||||
| MessageButtonOptions
|
||||
| MessageLinkOptions
|
||||
| MessageSelectOptions
|
||||
|
||||
export type MessageButtonOptions = {
|
||||
type: "button"
|
||||
|
||||
@@ -13,6 +13,6 @@ export * from "./core/components/link"
|
||||
export * from "./core/components/option"
|
||||
export * from "./core/components/select"
|
||||
export * from "./core/instance"
|
||||
export { useInstance } from "./core/instance-context"
|
||||
export * from "./core/reacord"
|
||||
export * from "./core/reacord-discord-js"
|
||||
export * from "./core/reacord-tester"
|
||||
|
||||
@@ -2,10 +2,27 @@
|
||||
"name": "reacord",
|
||||
"type": "module",
|
||||
"description": "Create interactive Discord messages using React.",
|
||||
"version": "0.1.1",
|
||||
"version": "0.3.5",
|
||||
"types": "./dist/main.d.ts",
|
||||
"homepage": "https://reacord.mapleleaf.dev",
|
||||
"repository": "https://github.com/itsMapleLeaf/reacord.git",
|
||||
"changelog": "https://github.com/itsMapleLeaf/reacord/releases",
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"discord",
|
||||
"discord-js",
|
||||
"react",
|
||||
"react-js",
|
||||
"react-renderer",
|
||||
"interaction",
|
||||
"message",
|
||||
"embed",
|
||||
"reacord"
|
||||
],
|
||||
"files": [
|
||||
"dist"
|
||||
"dist",
|
||||
"README.md",
|
||||
"LICENSE"
|
||||
],
|
||||
"exports": {
|
||||
".": {
|
||||
@@ -20,20 +37,19 @@
|
||||
"scripts": {
|
||||
"build": "tsup-node library/main.ts --target node16 --format cjs,esm --dts --sourcemap",
|
||||
"build-watch": "pnpm build -- --watch",
|
||||
"test": "node --experimental-vm-modules --no-warnings ./node_modules/jest/bin/jest.js --colors",
|
||||
"test-watch": "pnpm test -- --watch",
|
||||
"coverage": "pnpm test -- --coverage",
|
||||
"test": "vitest --coverage --no-watch",
|
||||
"test-dev": "vitest",
|
||||
"typecheck": "tsc --noEmit",
|
||||
"playground": "nodemon --exec esmo --ext ts,tsx ./playground/main.tsx",
|
||||
"release": "release-it"
|
||||
"playground": "nodemon --exec esmo --ext ts,tsx --inspect=5858 --enable-source-maps ./playground/main.tsx",
|
||||
"release": "bash scripts/release.sh"
|
||||
},
|
||||
"dependencies": {
|
||||
"@types/node": "*",
|
||||
"@types/react": "*",
|
||||
"@types/react-reconciler": "^0.26.4",
|
||||
"nanoid": "^3.1.30",
|
||||
"nanoid": "^3.1.31",
|
||||
"react-reconciler": "^0.26.2",
|
||||
"rxjs": "^7.5.1"
|
||||
"rxjs": "^7.5.2"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"discord.js": "^13.3",
|
||||
@@ -45,16 +61,13 @@
|
||||
}
|
||||
},
|
||||
"devDependencies": {
|
||||
"@jest/globals": "^27.4.6",
|
||||
"@types/jest": "^27.4.0",
|
||||
"@types/lodash-es": "^4.17.5",
|
||||
"c8": "^7.11.0",
|
||||
"discord.js": "^13.5.1",
|
||||
"dotenv": "^10.0.0",
|
||||
"dotenv": "^11.0.0",
|
||||
"esbuild": "latest",
|
||||
"esbuild-jest": "^0.5.0",
|
||||
"esmo": "^0.13.0",
|
||||
"jest": "^27.4.7",
|
||||
"lodash-es": "^4.17.21",
|
||||
"nodemon": "^2.0.15",
|
||||
"prettier": "^2.5.1",
|
||||
@@ -63,7 +76,9 @@
|
||||
"release-it": "^14.12.1",
|
||||
"tsup": "^5.11.11",
|
||||
"type-fest": "^2.9.0",
|
||||
"typescript": "^4.5.4"
|
||||
"typescript": "^4.5.4",
|
||||
"vite": "^2.7.10",
|
||||
"vitest": "^0.0.141"
|
||||
},
|
||||
"resolutions": {
|
||||
"esbuild": "latest"
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
import { Client } from "discord.js"
|
||||
import "dotenv/config"
|
||||
import React from "react"
|
||||
import { Button, ReacordDiscordJs } from "../library/main"
|
||||
import { Button, ReacordDiscordJs, useInstance } from "../library/main"
|
||||
import { createCommandHandler } from "./command-handler"
|
||||
import { Counter } from "./counter"
|
||||
import { FruitSelect } from "./fruit-select"
|
||||
@@ -93,6 +93,17 @@ createCommandHandler(client, [
|
||||
)
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "delete-this",
|
||||
description: "delete this",
|
||||
run: (interaction) => {
|
||||
function DeleteThis() {
|
||||
const instance = useInstance()
|
||||
return <Button label="delete this" onClick={() => instance.destroy()} />
|
||||
}
|
||||
reacord.reply(interaction, <DeleteThis />)
|
||||
},
|
||||
},
|
||||
])
|
||||
|
||||
await client.login(process.env.TEST_BOT_TOKEN)
|
||||
|
||||
4
packages/reacord/scripts/release.sh
Executable file
@@ -0,0 +1,4 @@
|
||||
pnpm build
|
||||
cp ../../README.md .
|
||||
cp ../../LICENSE .
|
||||
pnpx release-it
|
||||
@@ -1,6 +1,7 @@
|
||||
import React from "react"
|
||||
import { ReacordTester } from "../library/core/reacord-tester"
|
||||
import { test } from "vitest"
|
||||
import { ActionRow, Button, Select } from "../library/main"
|
||||
import { ReacordTester } from "./test-adapter"
|
||||
|
||||
const testing = new ReacordTester()
|
||||
|
||||
|
||||
@@ -1,2 +1,3 @@
|
||||
import { test } from "vitest"
|
||||
|
||||
test.todo("channel message renderer")
|
||||
export {}
|
||||
|
||||
@@ -1,2 +1,3 @@
|
||||
import { test } from "vitest"
|
||||
|
||||
test.todo("discord js integration")
|
||||
export {}
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import React from "react"
|
||||
import { ReacordTester } from "../library/core/reacord-tester"
|
||||
import { test } from "vitest"
|
||||
import {
|
||||
Embed,
|
||||
EmbedAuthor,
|
||||
@@ -9,6 +9,7 @@ import {
|
||||
EmbedThumbnail,
|
||||
EmbedTitle,
|
||||
} from "../library/main"
|
||||
import { ReacordTester } from "./test-adapter"
|
||||
|
||||
const testing = new ReacordTester()
|
||||
|
||||
|
||||
@@ -1,2 +1,2 @@
|
||||
import { test } from "vitest"
|
||||
test.todo("ephemeral reply")
|
||||
export {}
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
import { test } from "vitest"
|
||||
|
||||
test.todo("button onClick")
|
||||
test.todo("select onChange")
|
||||
export {}
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
import React from "react"
|
||||
import { ReacordTester } from "../library/core/reacord-tester"
|
||||
import { test } from "vitest"
|
||||
import { Link } from "../library/main"
|
||||
import { ReacordTester } from "./test-adapter"
|
||||
|
||||
const tester = new ReacordTester()
|
||||
|
||||
|
||||
@@ -1,11 +1,7 @@
|
||||
import * as React from "react"
|
||||
import {
|
||||
Button,
|
||||
Embed,
|
||||
EmbedField,
|
||||
EmbedTitle,
|
||||
ReacordTester,
|
||||
} from "../library/main"
|
||||
import { test } from "vitest"
|
||||
import { Button, Embed, EmbedField, EmbedTitle } from "../library/main"
|
||||
import { ReacordTester } from "./test-adapter"
|
||||
|
||||
test("rendering behavior", async () => {
|
||||
const tester = new ReacordTester()
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { test } from "vitest"
|
||||
|
||||
// test that the interaction update is _eventually_ deferred if there's no component update,
|
||||
// and that update isn't called after the fact
|
||||
// ...somehow
|
||||
test.todo("defer update timeout")
|
||||
|
||||
export {}
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
import { jest } from "@jest/globals"
|
||||
import React, { useState } from "react"
|
||||
import { Button, Option, ReacordTester, Select } from "../library/main"
|
||||
import { expect, fn, test } from "vitest"
|
||||
import { Button, Option, Select } from "../library/main"
|
||||
import { ReacordTester } from "./test-adapter"
|
||||
|
||||
test("single select", async () => {
|
||||
const tester = new ReacordTester()
|
||||
const onSelect = jest.fn()
|
||||
const onSelect = fn()
|
||||
|
||||
function TestSelect() {
|
||||
const [value, setValue] = useState<string>()
|
||||
@@ -74,7 +75,7 @@ test("single select", async () => {
|
||||
|
||||
test("multiple select", async () => {
|
||||
const tester = new ReacordTester()
|
||||
const onSelect = jest.fn()
|
||||
const onSelect = fn()
|
||||
|
||||
function TestSelect() {
|
||||
const [values, setValues] = useState<string[]>([])
|
||||
@@ -125,13 +126,13 @@ test("multiple select", async () => {
|
||||
expect(onSelect).toHaveBeenCalledTimes(0)
|
||||
|
||||
tester.findSelectByPlaceholder("select").select("1", "3")
|
||||
await assertSelect(expect.arrayContaining(["1", "3"]))
|
||||
await assertSelect(expect.arrayContaining(["1", "3"]) as unknown as string[])
|
||||
expect(onSelect).toHaveBeenCalledWith(
|
||||
expect.objectContaining({ values: expect.arrayContaining(["1", "3"]) }),
|
||||
)
|
||||
|
||||
tester.findSelectByPlaceholder("select").select("2")
|
||||
await assertSelect(expect.arrayContaining(["2"]))
|
||||
await assertSelect(expect.arrayContaining(["2"]) as unknown as string[])
|
||||
expect(onSelect).toHaveBeenCalledWith(
|
||||
expect.objectContaining({ values: expect.arrayContaining(["2"]) }),
|
||||
)
|
||||
|
||||
@@ -4,37 +4,41 @@ import { nanoid } from "nanoid"
|
||||
import { nextTick } from "node:process"
|
||||
import { promisify } from "node:util"
|
||||
import type { ReactNode } from "react"
|
||||
import { logPretty } from "../../helpers/log-pretty"
|
||||
import { omit } from "../../helpers/omit"
|
||||
import { raise } from "../../helpers/raise"
|
||||
import type { Channel } from "../internal/channel"
|
||||
import { Container } from "../internal/container"
|
||||
import type {
|
||||
ButtonInteraction,
|
||||
CommandInteraction,
|
||||
SelectInteraction,
|
||||
} from "../internal/interaction"
|
||||
import type {
|
||||
Message,
|
||||
MessageButtonOptions,
|
||||
MessageOptions,
|
||||
MessageSelectOptions,
|
||||
} from "../internal/message"
|
||||
import { ChannelMessageRenderer } from "../internal/renderers/channel-message-renderer"
|
||||
import { InteractionReplyRenderer } from "../internal/renderers/interaction-reply-renderer"
|
||||
import { expect } from "vitest"
|
||||
import { logPretty } from "../helpers/log-pretty"
|
||||
import { omit } from "../helpers/omit"
|
||||
import { pruneNullishValues } from "../helpers/prune-nullish-values"
|
||||
import { raise } from "../helpers/raise"
|
||||
import type {
|
||||
ChannelInfo,
|
||||
GuildInfo,
|
||||
MessageInfo,
|
||||
UserInfo,
|
||||
} from "./component-event"
|
||||
import type { ButtonClickEvent } from "./components/button"
|
||||
import type { SelectChangeEvent } from "./components/select"
|
||||
import type { ReacordInstance } from "./instance"
|
||||
import { Reacord } from "./reacord"
|
||||
} from "../library/core/component-event"
|
||||
import type { ButtonClickEvent } from "../library/core/components/button"
|
||||
import type { SelectChangeEvent } from "../library/core/components/select"
|
||||
import type { ReacordInstance } from "../library/core/instance"
|
||||
import { Reacord } from "../library/core/reacord"
|
||||
import type { Channel } from "../library/internal/channel"
|
||||
import { Container } from "../library/internal/container"
|
||||
import type {
|
||||
ButtonInteraction,
|
||||
CommandInteraction,
|
||||
SelectInteraction,
|
||||
} from "../library/internal/interaction"
|
||||
import type {
|
||||
Message,
|
||||
MessageButtonOptions,
|
||||
MessageOptions,
|
||||
MessageSelectOptions,
|
||||
} from "../library/internal/message"
|
||||
import { ChannelMessageRenderer } from "../library/internal/renderers/channel-message-renderer"
|
||||
import { InteractionReplyRenderer } from "../library/internal/renderers/interaction-reply-renderer"
|
||||
|
||||
const nextTickPromise = promisify(nextTick)
|
||||
|
||||
export type MessageSample = ReturnType<ReacordTester["sampleMessages"]>[0]
|
||||
|
||||
/**
|
||||
* A Record adapter for automated tests. WIP
|
||||
*/
|
||||
@@ -49,33 +53,32 @@ export class ReacordTester extends Reacord {
|
||||
return [...this.messageContainer]
|
||||
}
|
||||
|
||||
override send(): ReacordInstance {
|
||||
override send(initialContent?: ReactNode): ReacordInstance {
|
||||
return this.createInstance(
|
||||
new ChannelMessageRenderer(new TestChannel(this.messageContainer)),
|
||||
initialContent,
|
||||
)
|
||||
}
|
||||
|
||||
override reply(): ReacordInstance {
|
||||
override reply(initialContent?: ReactNode): ReacordInstance {
|
||||
return this.createInstance(
|
||||
new InteractionReplyRenderer(
|
||||
new TestCommandInteraction(this.messageContainer),
|
||||
),
|
||||
initialContent,
|
||||
)
|
||||
}
|
||||
|
||||
override ephemeralReply(): ReacordInstance {
|
||||
return this.reply()
|
||||
override ephemeralReply(initialContent?: ReactNode): ReacordInstance {
|
||||
return this.reply(initialContent)
|
||||
}
|
||||
|
||||
async assertMessages(expected: ReturnType<this["sampleMessages"]>) {
|
||||
async assertMessages(expected: MessageSample[]) {
|
||||
await nextTickPromise()
|
||||
expect(this.sampleMessages()).toEqual(expected)
|
||||
}
|
||||
|
||||
async assertRender(
|
||||
content: ReactNode,
|
||||
expected: ReturnType<this["sampleMessages"]>,
|
||||
) {
|
||||
async assertRender(content: ReactNode, expected: MessageSample[]) {
|
||||
const instance = this.reply()
|
||||
instance.render(content)
|
||||
await this.assertMessages(expected)
|
||||
@@ -87,14 +90,21 @@ export class ReacordTester extends Reacord {
|
||||
}
|
||||
|
||||
sampleMessages() {
|
||||
return this.messages.map((message) => ({
|
||||
...message.options,
|
||||
actionRows: message.options.actionRows.map((row) =>
|
||||
row.map((component) =>
|
||||
omit(component, ["customId", "onClick", "onSelect", "onSelectValue"]),
|
||||
return pruneNullishValues(
|
||||
this.messages.map((message) => ({
|
||||
...message.options,
|
||||
actionRows: message.options.actionRows.map((row) =>
|
||||
row.map((component) =>
|
||||
omit(component, [
|
||||
"customId",
|
||||
"onClick",
|
||||
"onSelect",
|
||||
"onSelectValue",
|
||||
]),
|
||||
),
|
||||
),
|
||||
),
|
||||
}))
|
||||
})),
|
||||
)
|
||||
}
|
||||
|
||||
findButtonByLabel(label: string) {
|
||||
@@ -265,11 +275,11 @@ class TestComponentEvent {
|
||||
guild: GuildInfo = {} as any // todo
|
||||
|
||||
reply(content?: ReactNode): ReacordInstance {
|
||||
return this.tester.reply()
|
||||
return this.tester.reply(content)
|
||||
}
|
||||
|
||||
ephemeralReply(content?: ReactNode): ReacordInstance {
|
||||
return this.tester.ephemeralReply()
|
||||
return this.tester.ephemeralReply(content)
|
||||
}
|
||||
}
|
||||
|
||||
72
packages/reacord/test/use-instance.test.tsx
Normal file
@@ -0,0 +1,72 @@
|
||||
import React from "react"
|
||||
import { describe, expect, it } from "vitest"
|
||||
import type { ReacordInstance } from "../library/main"
|
||||
import { Button, useInstance } from "../library/main"
|
||||
import type { MessageSample } from "./test-adapter"
|
||||
import { ReacordTester } from "./test-adapter"
|
||||
|
||||
describe("useInstance", () => {
|
||||
it("returns the instance of itself", async () => {
|
||||
let instanceFromHook: ReacordInstance | undefined
|
||||
|
||||
function TestComponent({ name }: { name: string }) {
|
||||
const instance = useInstance()
|
||||
instanceFromHook ??= instance
|
||||
return (
|
||||
<>
|
||||
<Button
|
||||
label={`create ${name}`}
|
||||
onClick={(event) => {
|
||||
event.reply(<TestComponent name="child" />)
|
||||
}}
|
||||
/>
|
||||
<Button
|
||||
label={`destroy ${name}`}
|
||||
onClick={() => instance.destroy()}
|
||||
/>
|
||||
</>
|
||||
)
|
||||
}
|
||||
|
||||
function messageOutput(name: string): MessageSample {
|
||||
return {
|
||||
content: "",
|
||||
embeds: [],
|
||||
actionRows: [
|
||||
[
|
||||
{
|
||||
type: "button",
|
||||
label: `create ${name}`,
|
||||
style: "secondary",
|
||||
},
|
||||
{
|
||||
type: "button",
|
||||
label: `destroy ${name}`,
|
||||
style: "secondary",
|
||||
},
|
||||
],
|
||||
],
|
||||
}
|
||||
}
|
||||
|
||||
const tester = new ReacordTester()
|
||||
const instance = tester.send(<TestComponent name="parent" />)
|
||||
|
||||
await tester.assertMessages([messageOutput("parent")])
|
||||
expect(instanceFromHook).toBe(instance)
|
||||
|
||||
tester.findButtonByLabel("create parent").click()
|
||||
await tester.assertMessages([
|
||||
messageOutput("parent"),
|
||||
messageOutput("child"),
|
||||
])
|
||||
|
||||
// this test ensures that the only the child instance is destroyed,
|
||||
// and not the parent instance
|
||||
tester.findButtonByLabel("destroy child").click()
|
||||
await tester.assertMessages([messageOutput("parent")])
|
||||
|
||||
tester.findButtonByLabel("destroy parent").click()
|
||||
await tester.assertMessages([])
|
||||
})
|
||||
})
|
||||
8
packages/reacord/vitest.config.ts
Normal file
@@ -0,0 +1,8 @@
|
||||
/// <reference types="vitest" />
|
||||
import { defineConfig } from "vite"
|
||||
|
||||
export default defineConfig({
|
||||
build: {
|
||||
sourcemap: true,
|
||||
},
|
||||
})
|
||||
@@ -5,3 +5,6 @@ node_modules
|
||||
/public/build
|
||||
.env
|
||||
/public/api
|
||||
cypress/videos
|
||||
cypress/screenshots
|
||||
*.out.css
|
||||
BIN
packages/website/app/assets/banner.png
Normal file
|
After Width: | Height: | Size: 97 KiB |
BIN
packages/website/app/assets/blob-comfy.png
Normal file
|
After Width: | Height: | Size: 10 KiB |
BIN
packages/website/app/assets/cursor-ibeam.png
Normal file
|
After Width: | Height: | Size: 1.3 KiB |
BIN
packages/website/app/assets/cursor.png
Normal file
|
After Width: | Height: | Size: 1.6 KiB |
3
packages/website/app/assets/dots-background.svg
Normal file
@@ -0,0 +1,3 @@
|
||||
<svg width="53" height="35" viewBox="0 0 53 35" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<circle cx="3" cy="3" r="1" fill="white"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 146 B |
BIN
packages/website/app/assets/favicon.png
Normal file
|
After Width: | Height: | Size: 658 B |
27
packages/website/app/modules/app/app-footer.tsx
Normal file
@@ -0,0 +1,27 @@
|
||||
import { HeartIcon } from "@heroicons/react/solid"
|
||||
import clsx from "clsx"
|
||||
import { ExternalLink } from "~/modules/dom/external-link"
|
||||
import { linkClass, maxWidthContainer } from "~/modules/ui/components"
|
||||
|
||||
export function AppFooter() {
|
||||
return (
|
||||
<footer className={clsx(maxWidthContainer, "text-xs opacity-75")}>
|
||||
<address className="not-italic">
|
||||
© {new Date().getFullYear()} itsMapleLeaf
|
||||
</address>
|
||||
<p>
|
||||
Coded with <HeartIcon className="inline w-4 align-sub" /> using{" "}
|
||||
<ExternalLink className={linkClass()} href="https://remix.run">
|
||||
Remix
|
||||
</ExternalLink>
|
||||
</p>
|
||||
<p>
|
||||
Uses{" "}
|
||||
<ExternalLink className={linkClass()} href="https://umami.is/">
|
||||
umami
|
||||
</ExternalLink>{" "}
|
||||
for simple, non-identifying analytics.
|
||||
</p>
|
||||
</footer>
|
||||
)
|
||||
}
|
||||
20
packages/website/app/modules/app/app-logo.tsx
Normal file
12
packages/website/app/modules/dom/external-link.tsx
Normal file
@@ -0,0 +1,12 @@
|
||||
import type { ComponentPropsWithoutRef } from "react"
|
||||
|
||||
export function ExternalLink({
|
||||
children,
|
||||
...props
|
||||
}: ComponentPropsWithoutRef<"a">) {
|
||||
return (
|
||||
<a target="_blank" rel="noopener noreferrer" {...props}>
|
||||
{children}
|
||||
</a>
|
||||
)
|
||||
}
|
||||
20
packages/website/app/modules/dom/portal.tsx
Normal file
@@ -0,0 +1,20 @@
|
||||
import type { ReactNode } from "react"
|
||||
import { useEffect, useRef } from "react"
|
||||
import { createPortal } from "react-dom"
|
||||
|
||||
export function Portal({ children }: { children: ReactNode }) {
|
||||
const containerRef = useRef<Element>()
|
||||
|
||||
if (!containerRef.current && typeof document !== "undefined") {
|
||||
containerRef.current = document.createElement("react-portal")
|
||||
document.body.append(containerRef.current)
|
||||
}
|
||||
|
||||
useEffect(() => () => containerRef.current!.remove(), [])
|
||||
|
||||
return containerRef.current ? (
|
||||
createPortal(children, containerRef.current)
|
||||
) : (
|
||||
<>{children}</>
|
||||
)
|
||||
}
|
||||
195
packages/website/app/modules/landing/landing-animation.tsx
Normal file
@@ -0,0 +1,195 @@
|
||||
import clsx from "clsx"
|
||||
import { useEffect, useRef, useState } from "react"
|
||||
import blobComfyUrl from "~/assets/blob-comfy.png"
|
||||
import cursorIbeamUrl from "~/assets/cursor-ibeam.png"
|
||||
import cursorUrl from "~/assets/cursor.png"
|
||||
|
||||
const defaultState = {
|
||||
chatInputText: "",
|
||||
chatInputCursorVisible: true,
|
||||
messageVisible: false,
|
||||
count: 0,
|
||||
cursorLeft: "25%",
|
||||
cursorBottom: "-15px",
|
||||
}
|
||||
|
||||
const delay = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms))
|
||||
|
||||
const animationFrame = () =>
|
||||
new Promise((resolve) => requestAnimationFrame(resolve))
|
||||
|
||||
export function LandingAnimation() {
|
||||
const [state, setState] = useState(defaultState)
|
||||
const chatInputRef = useRef<HTMLDivElement>(null)
|
||||
const addRef = useRef<HTMLDivElement>(null)
|
||||
const deleteRef = useRef<HTMLDivElement>(null)
|
||||
const cursorRef = useRef<HTMLImageElement>(null)
|
||||
|
||||
useEffect(() => {
|
||||
const animateClick = (element: HTMLElement) =>
|
||||
element.animate(
|
||||
[{ transform: `translateY(2px)` }, { transform: `translateY(0px)` }],
|
||||
300,
|
||||
)
|
||||
|
||||
let running = true
|
||||
|
||||
void (async () => {
|
||||
while (running) {
|
||||
setState(defaultState)
|
||||
await delay(700)
|
||||
|
||||
for (const letter of "/counter") {
|
||||
setState((state) => ({
|
||||
...state,
|
||||
chatInputText: state.chatInputText + letter,
|
||||
}))
|
||||
await delay(100)
|
||||
}
|
||||
|
||||
await delay(1000)
|
||||
|
||||
setState((state) => ({
|
||||
...state,
|
||||
messageVisible: true,
|
||||
chatInputText: "",
|
||||
}))
|
||||
await delay(1000)
|
||||
|
||||
setState((state) => ({
|
||||
...state,
|
||||
cursorLeft: "70px",
|
||||
cursorBottom: "40px",
|
||||
}))
|
||||
await delay(1500)
|
||||
|
||||
for (let i = 0; i < 3; i++) {
|
||||
setState((state) => ({
|
||||
...state,
|
||||
count: state.count + 1,
|
||||
chatInputCursorVisible: false,
|
||||
}))
|
||||
animateClick(addRef.current!)
|
||||
await delay(700)
|
||||
}
|
||||
|
||||
await delay(500)
|
||||
|
||||
setState((state) => ({
|
||||
...state,
|
||||
cursorLeft: "140px",
|
||||
}))
|
||||
await delay(1000)
|
||||
|
||||
animateClick(deleteRef.current!)
|
||||
setState((state) => ({ ...state, messageVisible: false }))
|
||||
await delay(1000)
|
||||
|
||||
setState(() => ({
|
||||
...defaultState,
|
||||
chatInputCursorVisible: false,
|
||||
}))
|
||||
await delay(500)
|
||||
}
|
||||
})()
|
||||
|
||||
return () => {
|
||||
running = false
|
||||
}
|
||||
}, [])
|
||||
|
||||
useEffect(() => {
|
||||
let running = true
|
||||
|
||||
void (async () => {
|
||||
while (running) {
|
||||
// check if the cursor is in the input
|
||||
const cursorRect = cursorRef.current!.getBoundingClientRect()
|
||||
const chatInputRect = chatInputRef.current!.getBoundingClientRect()
|
||||
|
||||
const isOverInput =
|
||||
cursorRef.current &&
|
||||
chatInputRef.current &&
|
||||
cursorRect.top + cursorRect.height / 2 > chatInputRect.top
|
||||
|
||||
cursorRef.current!.src = isOverInput ? cursorIbeamUrl : cursorUrl
|
||||
|
||||
await animationFrame()
|
||||
}
|
||||
})()
|
||||
|
||||
return () => {
|
||||
running = false
|
||||
}
|
||||
})
|
||||
|
||||
return (
|
||||
<div
|
||||
className="grid gap-2 relative pointer-events-none select-none"
|
||||
role="presentation"
|
||||
>
|
||||
<div
|
||||
className={clsx(
|
||||
"bg-slate-800 p-4 rounded-lg shadow transition",
|
||||
state.messageVisible ? "opacity-100" : "opacity-0 -translate-y-2",
|
||||
)}
|
||||
>
|
||||
<div className="flex items-start gap-4">
|
||||
<div className="w-12 h-12 p-2 rounded-full bg-no-repeat bg-contain bg-black/25">
|
||||
<img
|
||||
src={blobComfyUrl}
|
||||
alt=""
|
||||
className="object-contain scale-90 w-full h-full"
|
||||
/>
|
||||
</div>
|
||||
<div>
|
||||
<p className="font-bold">comfybot</p>
|
||||
<p>this button was clicked {state.count} times</p>
|
||||
<div className="mt-2 flex flex-row gap-3">
|
||||
<div
|
||||
ref={addRef}
|
||||
className="bg-emerald-700 text-white py-1.5 px-3 text-sm rounded"
|
||||
>
|
||||
+1
|
||||
</div>
|
||||
<div
|
||||
ref={deleteRef}
|
||||
className="bg-red-700 text-white py-1.5 px-3 text-sm rounded"
|
||||
>
|
||||
🗑 delete
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div
|
||||
className="bg-slate-700 pb-2 pt-1.5 px-4 rounded-lg shadow"
|
||||
ref={chatInputRef}
|
||||
>
|
||||
<span
|
||||
className={clsx(
|
||||
"text-sm after:content-[attr(data-after)] after:relative after:-top-px after:-left-[2px]",
|
||||
state.chatInputCursorVisible
|
||||
? "after:opacity-100"
|
||||
: "after:opacity-0",
|
||||
)}
|
||||
data-after="|"
|
||||
>
|
||||
{state.chatInputText || (
|
||||
<span className="opacity-50 block absolute translate-y-1">
|
||||
Message #showing-off-reacord
|
||||
</span>
|
||||
)}
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<img
|
||||
src={cursorUrl}
|
||||
alt=""
|
||||
className="transition-all duration-500 absolute scale-75"
|
||||
style={{ left: state.cursorLeft, bottom: state.cursorBottom }}
|
||||
ref={cursorRef}
|
||||
/>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
26
packages/website/app/modules/landing/landing-code.mdx
Normal file
@@ -0,0 +1,26 @@
|
||||
{/* prettier-ignore */}
|
||||
```tsx
|
||||
import * as React from "react"
|
||||
import { Button, useInstance } from "reacord"
|
||||
|
||||
function Counter() {
|
||||
const [count, setCount] = React.useState(0)
|
||||
const instance = useInstance()
|
||||
return (
|
||||
<>
|
||||
this button was clicked {count} times
|
||||
<Button
|
||||
label="+1"
|
||||
style="success"
|
||||
onClick={() => setCount(count + 1)}
|
||||
/>
|
||||
<Button
|
||||
label="delete"
|
||||
emoji="🗑"
|
||||
style="danger"
|
||||
onClick={() => instance.destroy()}
|
||||
/>
|
||||
</>
|
||||
)
|
||||
}
|
||||
```
|
||||
14
packages/website/app/modules/navigation/active-link.tsx
Normal file
@@ -0,0 +1,14 @@
|
||||
import type { ReactNode } from "react"
|
||||
import type { PathPattern } from "react-router"
|
||||
import { useMatch } from "react-router"
|
||||
|
||||
export function ActiveLink({
|
||||
to,
|
||||
children,
|
||||
}: {
|
||||
to: string | PathPattern
|
||||
children: (props: { active: boolean }) => ReactNode
|
||||
}) {
|
||||
const match = useMatch(to)
|
||||
return <>{children({ active: match != undefined })}</>
|
||||
}
|
||||
@@ -1,5 +1,6 @@
|
||||
import type { ComponentPropsWithoutRef } from "react"
|
||||
import { Link } from "remix"
|
||||
import { ExternalLink } from "~/modules/dom/external-link"
|
||||
|
||||
export type AppLinkProps = ComponentPropsWithoutRef<"a"> & {
|
||||
type: "internal" | "external" | "router"
|
||||
@@ -17,9 +18,9 @@ export function AppLink({ type, to, children, ...props }: AppLinkProps) {
|
||||
|
||||
if (type === "external") {
|
||||
return (
|
||||
<a href={to} target="_blank" rel="noopener noreferrer" {...props}>
|
||||
<ExternalLink href={to} {...props}>
|
||||
{children}
|
||||
</a>
|
||||
</ExternalLink>
|
||||
)
|
||||
}
|
||||
|
||||
@@ -18,7 +18,7 @@ export const mainLinks: AppLinkProps[] = [
|
||||
},
|
||||
{
|
||||
type: "internal",
|
||||
to: "/api",
|
||||
to: "/api/",
|
||||
children: (
|
||||
<>
|
||||
<CodeIcon className={inlineIconClass} /> API Reference
|
||||
@@ -0,0 +1,69 @@
|
||||
import { Menu, Transition } from "@headlessui/react"
|
||||
import { MenuAlt4Icon } from "@heroicons/react/outline"
|
||||
import clsx from "clsx"
|
||||
import { ActiveLink } from "~/modules/navigation/active-link"
|
||||
import { useGuideLinksContext } from "~/modules/navigation/guide-links-context"
|
||||
import { Popper } from "~/modules/ui/popper"
|
||||
import { AppLink } from "./app-link"
|
||||
import { mainLinks } from "./main-links"
|
||||
|
||||
export function MainNavigationMenu() {
|
||||
const guideLinks = useGuideLinksContext()
|
||||
return (
|
||||
<Menu>
|
||||
<Popper
|
||||
renderReference={(reference) => (
|
||||
<Menu.Button {...reference}>
|
||||
<MenuAlt4Icon className="w-6" />
|
||||
<span className="sr-only">Menu</span>
|
||||
</Menu.Button>
|
||||
)}
|
||||
renderPopover={() => (
|
||||
<Transition
|
||||
enter="transition"
|
||||
enterFrom="translate-y-4 opacity-0"
|
||||
enterTo="translate-y-0 opacity-100"
|
||||
leave="transition"
|
||||
leaveFrom="translate-y-0 opacity-100"
|
||||
leaveTo="translate-y-4 opacity-0"
|
||||
>
|
||||
<Menu.Items className="w-48 max-h-[calc(100vh-5rem)] bg-slate-800 shadow rounded-lg overflow-hidden overflow-y-auto focus:outline-none">
|
||||
{mainLinks.map((link) => (
|
||||
<Menu.Item key={link.to}>
|
||||
{({ active }) => (
|
||||
<AppLink {...link} className={menuItemClass({ active })} />
|
||||
)}
|
||||
</Menu.Item>
|
||||
))}
|
||||
<Menu.Item disabled>
|
||||
<hr className="border-0 h-[2px] bg-black/50" />
|
||||
</Menu.Item>
|
||||
{guideLinks.map(({ link }) => (
|
||||
<Menu.Item key={link.to}>
|
||||
{(menuItem) => (
|
||||
<ActiveLink to={link.to}>
|
||||
{(activeLink) => (
|
||||
<AppLink
|
||||
{...link}
|
||||
className={menuItemClass({
|
||||
active: activeLink.active || menuItem.active,
|
||||
})}
|
||||
/>
|
||||
)}
|
||||
</ActiveLink>
|
||||
)}
|
||||
</Menu.Item>
|
||||
))}
|
||||
</Menu.Items>
|
||||
</Transition>
|
||||
)}
|
||||
/>
|
||||
</Menu>
|
||||
)
|
||||
}
|
||||
|
||||
const menuItemClass = ({ active = false }) =>
|
||||
clsx(
|
||||
clsx`px-3 py-2 transition text-left font-medium block opacity-50`,
|
||||
active && clsx`opacity-100 bg-black/75 text-emerald-400`,
|
||||
)
|
||||
24
packages/website/app/modules/navigation/main-navigation.tsx
Normal file
@@ -0,0 +1,24 @@
|
||||
import { AppLogo } from "~/modules/app/app-logo"
|
||||
import { linkClass } from "../ui/components"
|
||||
import { AppLink } from "./app-link"
|
||||
import { mainLinks } from "./main-links"
|
||||
import { MainNavigationMenu } from "./main-navigation-menu"
|
||||
|
||||
export function MainNavigation() {
|
||||
return (
|
||||
<nav className="flex justify-between items-center h-16">
|
||||
<a href="/">
|
||||
<AppLogo className="w-32" />
|
||||
<span className="sr-only">Home</span>
|
||||
</a>
|
||||
<div className="hidden md:flex gap-4">
|
||||
{mainLinks.map((link) => (
|
||||
<AppLink {...link} key={link.to} className={linkClass()} />
|
||||
))}
|
||||
</div>
|
||||
<div className="md:hidden">
|
||||
<MainNavigationMenu />
|
||||
</div>
|
||||
</nav>
|
||||
)
|
||||
}
|
||||
44
packages/website/app/modules/ui/components.ts
Normal file
@@ -0,0 +1,44 @@
|
||||
import clsx from "clsx"
|
||||
|
||||
export const maxWidthContainer = clsx`mx-auto w-full max-w-screen-lg px-4`
|
||||
|
||||
export const inlineIconClass = clsx`inline w-5 align-sub`
|
||||
|
||||
export const linkClass = ({ active = false } = {}) =>
|
||||
clsx(
|
||||
clsx`font-medium inline-block relative`,
|
||||
clsx`opacity-60 hover:opacity-100 transition-opacity`,
|
||||
clsx`after:absolute after:block after:w-full after:h-px after:bg-white/50 after:translate-y-[3px] after:opacity-0 after:transition`,
|
||||
clsx`hover:after:translate-y-[-1px] hover:after:opacity-100`,
|
||||
active
|
||||
? clsx`text-emerald-500 after:bg-emerald-500`
|
||||
: clsx`after:bg-white/50`,
|
||||
)
|
||||
|
||||
export const docsProseClass = clsx`
|
||||
prose prose-invert
|
||||
prose-h1:font-light prose-h1:mb-4 prose-h1:text-3xl lg:prose-h1:text-4xl
|
||||
prose-h2:font-light
|
||||
prose-h3:font-light
|
||||
prose-p:my-3
|
||||
prose-a:font-medium prose-a:text-emerald-400 hover:prose-a:no-underline
|
||||
prose-strong:font-medium prose-strong:text-emerald-400
|
||||
prose-pre:font-monospace prose-pre:overflow-x-auto
|
||||
prose-code:before:hidden prose-code:after:hidden prose-code:text-slate-400
|
||||
prose-li:mb-5
|
||||
max-w-none
|
||||
`
|
||||
|
||||
export const buttonClass = ({
|
||||
variant,
|
||||
}: {
|
||||
variant: "solid" | "semiblack"
|
||||
}) => {
|
||||
return clsx(
|
||||
clsx`inline-block mt-4 px-4 py-2.5 text-xl transition rounded-lg`,
|
||||
clsx`hover:translate-y-[-2px] hover:shadow`,
|
||||
clsx`active:translate-y-[0px] active:transition-none`, // using translate-y-[0px] instead of just -0 so it takes priority
|
||||
variant === "solid" && clsx`bg-emerald-700 hover:bg-emerald-800`,
|
||||
variant === "semiblack" && clsx`bg-black/25 hover:bg-black/40`,
|
||||
)
|
||||
}
|
||||
80
packages/website/app/modules/ui/modal.tsx
Normal file
@@ -0,0 +1,80 @@
|
||||
import { XIcon } from "@heroicons/react/outline"
|
||||
import clsx from "clsx"
|
||||
import type { ReactNode } from "react"
|
||||
import { useEffect, useRef, useState } from "react"
|
||||
import { FocusOn } from "react-focus-on"
|
||||
import { Portal } from "~/modules/dom/portal"
|
||||
|
||||
export function Modal({
|
||||
children,
|
||||
visible,
|
||||
onClose,
|
||||
}: {
|
||||
children: ReactNode
|
||||
visible: boolean
|
||||
onClose: () => void
|
||||
}) {
|
||||
const closeButtonRef = useRef<HTMLButtonElement>(null)
|
||||
|
||||
useEffect(() => {
|
||||
if (visible) {
|
||||
// trying to immediately focus doesn't work for whatever reason
|
||||
// neither did requestAnimationFrame
|
||||
setTimeout(() => {
|
||||
closeButtonRef.current?.focus()
|
||||
}, 50)
|
||||
}
|
||||
}, [visible])
|
||||
|
||||
return (
|
||||
<Portal>
|
||||
<div
|
||||
className={clsx(
|
||||
"bg-black/70 fixed inset-0 transition-all flex flex-col p-4",
|
||||
visible ? "opacity-100 visible" : "opacity-0 invisible",
|
||||
)}
|
||||
>
|
||||
<FocusOn
|
||||
className={clsx(
|
||||
"m-auto flex flex-col gap-2 w-full max-h-full max-w-screen-sm overflow-y-auto transition",
|
||||
visible ? "translate-y-0" : "translate-y-3",
|
||||
)}
|
||||
enabled={visible}
|
||||
onClickOutside={onClose}
|
||||
onEscapeKey={onClose}
|
||||
>
|
||||
<button
|
||||
type="button"
|
||||
className="self-end"
|
||||
onClick={onClose}
|
||||
ref={closeButtonRef}
|
||||
>
|
||||
<span className="sr-only">Close</span>
|
||||
<XIcon aria-hidden className="w-6 text-white" />
|
||||
</button>
|
||||
<div className={clsx("bg-slate-700 rounded-md shadow p-4")}>
|
||||
{children}
|
||||
</div>
|
||||
</FocusOn>
|
||||
</div>
|
||||
</Portal>
|
||||
)
|
||||
}
|
||||
|
||||
export function UncontrolledModal({
|
||||
children,
|
||||
button,
|
||||
}: {
|
||||
children: ReactNode
|
||||
button: (buttonProps: { onClick: () => void }) => void
|
||||
}) {
|
||||
const [visible, setVisible] = useState(false)
|
||||
return (
|
||||
<>
|
||||
{button({ onClick: () => setVisible(true) })}
|
||||
<Modal visible={visible} onClose={() => setVisible(false)}>
|
||||
{children}
|
||||
</Modal>
|
||||
</>
|
||||
)
|
||||
}
|
||||
41
packages/website/app/modules/ui/popper.tsx
Normal file
@@ -0,0 +1,41 @@
|
||||
import { useRect } from "@reach/rect"
|
||||
import * as React from "react"
|
||||
import { Portal } from "~/modules/dom/portal"
|
||||
|
||||
export function Popper({
|
||||
renderReference,
|
||||
renderPopover,
|
||||
}: {
|
||||
renderReference: (referenceProps: {
|
||||
ref: (element: HTMLElement | null | undefined) => void
|
||||
}) => React.ReactNode
|
||||
renderPopover: () => React.ReactNode
|
||||
}) {
|
||||
const [reference, referenceRef] = React.useState<HTMLElement | null>()
|
||||
const referenceRect = useRect(useValueAsRefObject(reference))
|
||||
|
||||
return (
|
||||
<>
|
||||
{renderReference({ ref: referenceRef })}
|
||||
<Portal>
|
||||
{referenceRect && (
|
||||
<div
|
||||
className="fixed -translate-x-full"
|
||||
style={{
|
||||
left: referenceRect.right,
|
||||
top: referenceRect.bottom + 16,
|
||||
}}
|
||||
>
|
||||
{renderPopover()}
|
||||
</div>
|
||||
)}
|
||||
</Portal>
|
||||
</>
|
||||
)
|
||||
}
|
||||
|
||||
function useValueAsRefObject<Value>(value: Value): { readonly current: Value } {
|
||||
const ref = React.useRef<Value>(value)
|
||||
ref.current = value
|
||||
return ref
|
||||
}
|
||||
@@ -5,20 +5,41 @@ import {
|
||||
LiveReload,
|
||||
Meta,
|
||||
Outlet,
|
||||
Scripts,
|
||||
ScrollRestoration,
|
||||
useLoaderData,
|
||||
} from "remix"
|
||||
import bannerUrl from "~/assets/banner.png"
|
||||
import faviconUrl from "~/assets/favicon.png"
|
||||
import { GuideLinksProvider } from "~/modules/navigation/guide-links-context"
|
||||
import type { GuideLink } from "~/modules/navigation/load-guide-links.server"
|
||||
import { loadGuideLinks } from "~/modules/navigation/load-guide-links.server"
|
||||
import prismThemeCss from "~/modules/ui/prism-theme.css"
|
||||
import tailwindCss from "~/modules/ui/tailwind.out.css"
|
||||
|
||||
export const meta: MetaFunction = () => ({
|
||||
title: "Reacord",
|
||||
description: packageJson.description,
|
||||
"title": "Reacord",
|
||||
"description": packageJson.description,
|
||||
"theme-color": "#21754b",
|
||||
|
||||
"og:url": "https://reacord.mapleleaf.dev/",
|
||||
"og:type": "website",
|
||||
"og:title": "Reacord",
|
||||
"og:description": "Create interactive Discord messages using React",
|
||||
"og:image": bannerUrl,
|
||||
|
||||
"twitter:card": "summary_large_image",
|
||||
"twitter:domain": "reacord.mapleleaf.dev",
|
||||
"twitter:url": "https://reacord.mapleleaf.dev/",
|
||||
"twitter:title": "Reacord",
|
||||
"twitter:description": "Create interactive Discord messages using React",
|
||||
"twitter:image": bannerUrl,
|
||||
})
|
||||
|
||||
export const links: LinksFunction = () => [
|
||||
{ rel: "icon", type: "image/png", href: faviconUrl },
|
||||
{ rel: "stylesheet", href: tailwindCss },
|
||||
{ rel: "stylesheet", href: prismThemeCss },
|
||||
{ rel: "preconnect", href: "https://fonts.googleapis.com" },
|
||||
{
|
||||
rel: "preconnect",
|
||||
@@ -30,8 +51,10 @@ export const links: LinksFunction = () => [
|
||||
as: "style",
|
||||
href: "https://fonts.googleapis.com/css2?family=JetBrains+Mono:wght@500&family=Rubik:ital,wght@0,300;0,400;0,500;1,300;1,400;1,500&display=swap",
|
||||
},
|
||||
{ rel: "stylesheet", href: "/tailwind.css" },
|
||||
{ rel: "stylesheet", href: prismThemeCss },
|
||||
{
|
||||
rel: "stylesheet",
|
||||
href: "https://fonts.googleapis.com/css2?family=JetBrains+Mono:wght@500&family=Rubik:ital,wght@0,300;0,400;0,500;1,300;1,400;1,500&display=swap",
|
||||
},
|
||||
]
|
||||
|
||||
type LoaderData = {
|
||||
@@ -54,13 +77,20 @@ export default function App() {
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||
<Meta />
|
||||
<Links />
|
||||
<script defer src="https://unpkg.com/alpinejs@3.7.1/dist/cdn.min.js" />
|
||||
{process.env.NODE_ENV === "production" && (
|
||||
<script
|
||||
async
|
||||
data-website-id="49c69ade-5593-4853-9686-c9ca9d519a18"
|
||||
src="https://umami-production-265f.up.railway.app/umami.js"
|
||||
/>
|
||||
)}
|
||||
</head>
|
||||
<body>
|
||||
<GuideLinksProvider value={data.guideLinks}>
|
||||
<Outlet />
|
||||
</GuideLinksProvider>
|
||||
<ScrollRestoration />
|
||||
<Scripts />
|
||||
{process.env.NODE_ENV === "development" && <LiveReload />}
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,5 +1,6 @@
|
||||
import clsx from "clsx"
|
||||
import { Outlet } from "remix"
|
||||
import { ActiveLink } from "~/modules/navigation/active-link"
|
||||
import { AppLink } from "~/modules/navigation/app-link"
|
||||
import { useGuideLinksContext } from "~/modules/navigation/guide-links-context"
|
||||
import { MainNavigation } from "~/modules/navigation/main-navigation"
|
||||
@@ -12,7 +13,7 @@ import {
|
||||
export default function GuidePage() {
|
||||
const guideLinks = useGuideLinksContext()
|
||||
return (
|
||||
<>
|
||||
<div className="isolate">
|
||||
<header className="bg-slate-700/30 shadow sticky top-0 backdrop-blur-sm transition z-10 flex">
|
||||
<div className={maxWidthContainer}>
|
||||
<MainNavigation />
|
||||
@@ -24,7 +25,11 @@ export default function GuidePage() {
|
||||
<ul className="mt-3 flex flex-col gap-2 items-start">
|
||||
{guideLinks.map(({ link }) => (
|
||||
<li key={link.to}>
|
||||
<AppLink {...link} className={linkClass} />
|
||||
<ActiveLink to={link.to}>
|
||||
{({ active }) => (
|
||||
<AppLink {...link} className={linkClass({ active })} />
|
||||
)}
|
||||
</ActiveLink>
|
||||
</li>
|
||||
))}
|
||||
</ul>
|
||||
@@ -33,6 +38,6 @@ export default function GuidePage() {
|
||||
<Outlet />
|
||||
</section>
|
||||
</main>
|
||||
</>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
26
packages/website/app/routes/guides/use-instance.md
Normal file
@@ -0,0 +1,26 @@
|
||||
---
|
||||
meta:
|
||||
title: useInstance
|
||||
description: Using useInstance to get the current instance within a component
|
||||
---
|
||||
|
||||
# useInstance
|
||||
|
||||
You can use `useInstance` to get the current [instance](/guides/sending-messages) within a component. This can be used to let a component destroy or deactivate itself.
|
||||
|
||||
```jsx
|
||||
import { Button, useInstance } from "reacord"
|
||||
|
||||
function SelfDestruct() {
|
||||
const instance = useInstance()
|
||||
return (
|
||||
<Button
|
||||
style="danger"
|
||||
label="delete this"
|
||||
onClick={() => instance.destroy()}
|
||||
/>
|
||||
)
|
||||
}
|
||||
|
||||
reacord.send(channelId, <SelfDestruct />)
|
||||
```
|
||||
63
packages/website/app/routes/index.tsx
Normal file
@@ -0,0 +1,63 @@
|
||||
import dotsBackgroundUrl from "~/assets/dots-background.svg"
|
||||
import { AppFooter } from "~/modules/app/app-footer"
|
||||
import { AppLogo } from "~/modules/app/app-logo"
|
||||
import LandingCode from "~/modules/landing/landing-code.mdx"
|
||||
import { MainNavigation } from "~/modules/navigation/main-navigation"
|
||||
import { buttonClass, maxWidthContainer } from "~/modules/ui/components"
|
||||
import { LandingAnimation } from "../modules/landing/landing-animation"
|
||||
import { UncontrolledModal } from "../modules/ui/modal"
|
||||
|
||||
export default function Landing() {
|
||||
return (
|
||||
<>
|
||||
<div
|
||||
className="fixed inset-0 rotate-6 scale-125 opacity-20"
|
||||
style={{ backgroundImage: `url(${dotsBackgroundUrl})` }}
|
||||
/>
|
||||
<div className="flex flex-col relative min-w-0 min-h-screen pb-4 gap-4">
|
||||
<header className={maxWidthContainer}>
|
||||
<MainNavigation />
|
||||
</header>
|
||||
<div className="flex flex-col gap-4 my-auto px-4">
|
||||
<AppLogo className="w-full max-w-lg mx-auto" />
|
||||
|
||||
<div className="max-w-md w-full mx-auto">
|
||||
<LandingAnimation />
|
||||
</div>
|
||||
|
||||
<p className="text-center text-lg font-light -mb-1">
|
||||
Create interactive Discord messages with React.
|
||||
</p>
|
||||
|
||||
<div className="flex gap-4 self-center">
|
||||
<a
|
||||
href="/guides/getting-started"
|
||||
className={buttonClass({ variant: "solid" })}
|
||||
>
|
||||
Get Started
|
||||
</a>
|
||||
|
||||
<UncontrolledModal
|
||||
button={(button) => (
|
||||
<button
|
||||
{...button}
|
||||
className={buttonClass({ variant: "semiblack" })}
|
||||
>
|
||||
Show Code
|
||||
</button>
|
||||
)}
|
||||
>
|
||||
<div className="text-sm sm:text-base">
|
||||
<LandingCode />
|
||||
</div>
|
||||
</UncontrolledModal>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div className="text-center">
|
||||
<AppFooter />
|
||||
</div>
|
||||
</div>
|
||||
</>
|
||||
)
|
||||
}
|
||||
@@ -16,7 +16,7 @@
|
||||
* @type {Cypress.PluginConfig}
|
||||
*/
|
||||
// eslint-disable-next-line no-unused-vars
|
||||
// module.exports = (on, config) => {
|
||||
// `on` is used to hook into various events Cypress emits
|
||||
// `config` is the resolved Cypress config
|
||||
// }
|
||||
export default function cypressConfig(on, config) {
|
||||
// `on` is used to hook into various events Cypress emits
|
||||
// `config` is the resolved Cypress config
|
||||
}
|
||||
@@ -1,31 +1,33 @@
|
||||
{
|
||||
"private": true,
|
||||
"name": "reacord-docs-new",
|
||||
"name": "website",
|
||||
"scripts": {
|
||||
"prepare": "remix setup node",
|
||||
"dev": "concurrently 'typedoc --watch' 'remix dev'",
|
||||
"test": "pnpm build && pnpm start & wait-on http-get://localhost:3000 && cypress run",
|
||||
"dev": "concurrently 'typedoc --watch' 'pnpm tailwind -- --watch' 'remix dev'",
|
||||
"test": "node ./scripts/test.js",
|
||||
"test-dev": "pnpm dev & wait-on http-get://localhost:3000 && cypress open",
|
||||
"build": "typedoc && remix build",
|
||||
"build": "typedoc && pnpm tailwind -- --minify && remix build",
|
||||
"start": "remix-serve build",
|
||||
"tailwind": "tailwindcss --config tailwind.config.cjs --input app/modules/ui/tailwind.css --output app/modules/ui/tailwind.out.css",
|
||||
"typecheck": "tsc --noEmit && tsc --project cypress/tsconfig.json --noEmit"
|
||||
},
|
||||
"dependencies": {
|
||||
"@headlessui/react": "^1.4.2",
|
||||
"@heroicons/react": "^1.0.5",
|
||||
"@reach/rect": "^0.16.0",
|
||||
"@remix-run/react": "^1.1.1",
|
||||
"@remix-run/serve": "^1.1.1",
|
||||
"@tailwindcss/typography": "^0.5.0",
|
||||
"autoprefixer": "^10.4.2",
|
||||
"clsx": "^1.1.1",
|
||||
"fast-glob": "^3.2.10",
|
||||
"gray-matter": "^4.0.3",
|
||||
"postcss": "^8.4.5",
|
||||
"reacord": "workspace:*",
|
||||
"react": "^17.0.2",
|
||||
"react-dom": "^17.0.2",
|
||||
"remix": "^1.1.1",
|
||||
"remix-tailwind": "^0.2.1",
|
||||
"tailwindcss": "^3.0.12"
|
||||
"react-focus-on": "^3.5.4",
|
||||
"react-router": "^6.2.1",
|
||||
"react-router-dom": "^6.2.1",
|
||||
"remix": "^1.1.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@remix-run/dev": "^1.1.1",
|
||||
@@ -35,9 +37,14 @@
|
||||
"@types/react": "^17.0.38",
|
||||
"@types/react-dom": "^17.0.11",
|
||||
"@types/tailwindcss": "^3.0.2",
|
||||
"@types/wait-on": "^5.3.1",
|
||||
"autoprefixer": "^10.4.2",
|
||||
"concurrently": "^7.0.0",
|
||||
"cypress": "^9.2.0",
|
||||
"rehype-prism-plus": "^1.2.2",
|
||||
"cypress": "^9.2.1",
|
||||
"execa": "^6.0.0",
|
||||
"postcss": "^8.4.5",
|
||||
"rehype-prism-plus": "^1.3.1",
|
||||
"tailwindcss": "^3.0.13",
|
||||
"typedoc": "^0.22.10",
|
||||
"typescript": "^4.5.4",
|
||||
"wait-on": "^6.0.0"
|
||||
3
packages/website/scripts/package.json
Normal file
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"type": "module"
|
||||
}
|
||||
9
packages/website/scripts/test.js
Normal file
@@ -0,0 +1,9 @@
|
||||
import cypress from "cypress"
|
||||
import { execa } from "execa"
|
||||
import waitOn from "wait-on"
|
||||
|
||||
await execa("pnpm", ["build"], { stdio: "inherit" })
|
||||
const app = execa("pnpm", ["start"], { stdio: "inherit" })
|
||||
await waitOn({ resources: ["http-get://localhost:3000"] })
|
||||
await cypress.run()
|
||||
app.kill()
|
||||