@q9labsai/chalk-react 4.1.0 → 4.1.2

package/README.md

@@ -40,9 +40,11 @@ application. Chalk will use it without disposing it.
 <Chalk client={spaceClient} entrance={false} />
 ```
 
-`theme` is the only styling door. It accepts a closed token-key set, which
-Chalk emits as CSS custom properties scoped to its root. Size and place Chalk
-with its parent element.
+`theme` is the only styling door. `skin` defaults to `"classic"`; choose
+`"chalk"` when you want the hand-drawn Chalk skin. Palette and texture are
+independent from the skin, so the same palette and texture can compose with
+either choice. Chalk emits the closed token-key set as CSS custom properties
+scoped to its root. Size and place Chalk with its parent element.
 
 `colorScheme` accepts `light`, `dark`, or `system`. With `system`, Chalk follows
 the browser preference while keeping explicit token overrides in place.
@@ -51,6 +53,9 @@ the browser preference while keeping explicit token overrides in place.
 <Chalk
   client={spaceClient}
   theme={{
+    skin: "chalk",
+    palette: "warm-charcoal",
+    texture: "paper",
     colorScheme: "dark",
     accent: "#4b9bb8",
     tokens: { canvas: "#152127", surface: "#1d2b31" },
@@ -58,6 +63,43 @@ the browser preference while keeping explicit token overrides in place.
 />
 ```
 
+`COSMIC_CHALK_THEME` is a ready-made Chalk-skin theme with a midnight board,
+moon-white text, comet-blue focus states, and a slate grain. The preset selects
+`skin: "chalk"`; it works on the full Space and the standalone Entrance.
+
+```tsx
+import { Chalk, COSMIC_CHALK_THEME, Entrance } from "@q9labsai/chalk-react";
+
+<Chalk client={spaceClient} theme={COSMIC_CHALK_THEME} />;
+
+<Entrance spaceName="Design review" theme={COSMIC_CHALK_THEME} onJoin={(settings) => spaceClient.join(settings)} />;
+```
+
+## Hand-drawn UI
+
+The `chalk` skin uses the SDK's chalk-drawn controls throughout. Its rough SVG
+edges, powder passes, and focus marks are deterministic, while buttons, inputs,
+toggles, dialogs, menus, and sliders remain native accessible controls. The
+default `classic` skin keeps the same typed palette and texture choices without
+the hand-drawn treatment.
+
+The same pieces are public for custom panels. Each accepts a stable `seed` when
+you want a specific stroke to stay identical across renders.
+Directly imported `Chalk*` primitives keep their hand-drawn identity; the skin
+switch belongs to the turnkey `<Chalk />` and standalone `Entrance` surfaces.
+
+```tsx
+import { ChalkButton, ChalkInput, ChalkPanel, ChalkToggle } from "@q9labsai/chalk-react";
+
+<ChalkPanel seed="participant-settings">
+  <ChalkInput aria-label="Display name" defaultValue="Hasan" seed="display-name" />
+  <ChalkToggle aria-label="Noise suppression" defaultPressed seed="noise-suppression" />
+  <ChalkButton tone="accent" variant="solid" seed="save-settings">
+    Save settings
+  </ChalkButton>
+</ChalkPanel>;
+```
+
 ## Custom UI
 
 `ChalkProvider` only shares a `SpaceClient` with React. It does not join,
@@ -65,7 +107,7 @@ leave, refresh access, or own the client’s lifetime.
 
 ```tsx
 import type { SpaceClient } from "@q9labsai/chalk-client";
-import { ChalkProvider, useCan, useParticipants, useSpaceClient } from "@q9labsai/chalk-react";
+import { ChalkButton, ChalkProvider, useCan, useParticipants, useSpaceClient } from "@q9labsai/chalk-react";
 
 function ParticipantPanel() {
   const client = useSpaceClient();
@@ -75,7 +117,7 @@ function ParticipantPanel() {
   return (
     <>
       <p>{roster.length} participants</p>
-      {canRaiseHand ? <button onClick={() => void client.participants.raiseHand()}>Raise hand</button> : null}
+      {canRaiseHand ? <ChalkButton onClick={() => void client.participants.raiseHand()}>Raise hand</ChalkButton> : null}
     </>
   );
 }

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,27 @@
+# Third-party notices
+
+Parts of the deterministic rough-path and chalk-texture implementation are
+adapted from Drawably/Chalkably.
+
+MIT License
+
+Copyright (c) 2026 Daniel Belyi
+Copyright (c) 2026 Hasan Shoaib (modifications)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.