Compare commits
181 Commits
jazz-react
...
jazz-react
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b62d75b847 | ||
|
|
beafbd3088 | ||
|
|
653d8ba69f | ||
|
|
6c23dab790 | ||
|
|
80530a4065 | ||
|
|
2ba5ea684e | ||
|
|
a8466946d3 | ||
|
|
105b240076 | ||
|
|
097dd8a646 | ||
|
|
138dd7ee8b | ||
|
|
5b17085b30 | ||
|
|
cb7bdffabe | ||
|
|
90892523da | ||
|
|
693a058890 | ||
|
|
4d20f1bcfc | ||
|
|
36bf3924ff | ||
|
|
6b6fc8b31a | ||
|
|
1649f06667 | ||
|
|
e9bd290dec | ||
|
|
9d76292db5 | ||
|
|
66373bade3 | ||
|
|
40118a0b2c | ||
|
|
86b57415b8 | ||
|
|
cdbc37a144 | ||
|
|
e996c71e83 | ||
|
|
0f704a2330 | ||
|
|
2f206e7613 | ||
|
|
761759c893 | ||
|
|
15c57e24ad | ||
|
|
580e2577c9 | ||
|
|
3804198c02 | ||
|
|
537d56a30e | ||
|
|
5524d3e0cb | ||
|
|
3d2682e3a7 | ||
|
|
0c131f3af4 | ||
|
|
fada6b0eb5 | ||
|
|
c8b94475cd | ||
|
|
162a024345 | ||
|
|
7cd195b3a4 | ||
|
|
ccad5a3c70 | ||
|
|
4268d189cb | ||
|
|
d48712986f | ||
|
|
ba2fda5de1 | ||
|
|
b1d26f23d6 | ||
|
|
e7766746d9 | ||
|
|
7c64d104a6 | ||
|
|
1870a1268a | ||
|
|
a8222368d0 | ||
|
|
72d11ce003 | ||
|
|
5fbf9770d2 | ||
|
|
707dedb33e | ||
|
|
86d42d9e49 | ||
|
|
64f01915f4 | ||
|
|
9a8fd2ce47 | ||
|
|
4dc7cdb4e6 | ||
|
|
84b993944d | ||
|
|
fa064443a0 | ||
|
|
32e9678394 | ||
|
|
b1850efd7f | ||
|
|
922e3c8244 | ||
|
|
1c063455d1 | ||
|
|
35abeba323 | ||
|
|
84f623097f | ||
|
|
73015a3438 | ||
|
|
7c3bf78fef | ||
|
|
68cb6064a5 | ||
|
|
992d5e572e | ||
|
|
c75a3042ce | ||
|
|
fa8b20899d | ||
|
|
f24cad1909 | ||
|
|
8b2df0e5e2 | ||
|
|
f93222079f | ||
|
|
514f4c9a72 | ||
|
|
d5daf060c9 | ||
|
|
604cd4e3a9 | ||
|
|
3446b38f69 | ||
|
|
de12b03d3f | ||
|
|
c3db5cf0b5 | ||
|
|
e7f2521b41 | ||
|
|
0c6cd571c9 | ||
|
|
e1d56a45f7 | ||
|
|
e40e01fce0 | ||
|
|
d70343d864 | ||
|
|
160ab768e9 | ||
|
|
4ff03f67d9 | ||
|
|
5a81adffec | ||
|
|
f4fdb3c14e | ||
|
|
d001144a87 | ||
|
|
ded473b75e | ||
|
|
602c34b0f2 | ||
|
|
77cf06945a | ||
|
|
61f39bb56f | ||
|
|
7cc51b77f3 | ||
|
|
bf303d58e3 | ||
|
|
def5c474e6 | ||
|
|
c81dca23ad | ||
|
|
b470f63f86 | ||
|
|
5c7072bf6e | ||
|
|
bd62b1342a | ||
|
|
af314e8584 | ||
|
|
8ad1878f86 | ||
|
|
2fe5cd1326 | ||
|
|
2ae0b8df0d | ||
|
|
77dc51d466 | ||
|
|
bd645db4cc | ||
|
|
af46c68a4a | ||
|
|
fb58cb9299 | ||
|
|
b3605c0c22 | ||
|
|
63fb80e50d | ||
|
|
133b8abcbe | ||
|
|
e272849026 | ||
|
|
c4fdfeaa48 | ||
|
|
3f0859c3f2 | ||
|
|
6e286bac7e | ||
|
|
235aab15b6 | ||
|
|
a440121ac9 | ||
|
|
6209bd2285 | ||
|
|
8ad9fc57cc | ||
|
|
a763b947b8 | ||
|
|
026a26da3c | ||
|
|
d8d1addf2b | ||
|
|
937a34c76e | ||
|
|
c6142a1f64 | ||
|
|
f3fb2dee52 | ||
|
|
15996ced64 | ||
|
|
9fb98e2114 | ||
|
|
f55f779ea1 | ||
|
|
18c98fc3f5 | ||
|
|
41b286b672 | ||
|
|
3c97e8e7f2 | ||
|
|
7996a2aa9c | ||
|
|
ba944c20ed | ||
|
|
0b89fadfdd | ||
|
|
1e50cebf55 | ||
|
|
ca8c5c0b02 | ||
|
|
a0aa261cab | ||
|
|
5d3d11e87c | ||
|
|
4a9ed21ea2 | ||
|
|
2ddfc9d92b | ||
|
|
a032fda936 | ||
|
|
c6fb8dc845 | ||
|
|
bf399d72c1 | ||
|
|
60fefe8158 | ||
|
|
9be66e196c | ||
|
|
04d96e52e0 | ||
|
|
5b483dac6f | ||
|
|
fadb4bf76e | ||
|
|
98a25b1fd6 | ||
|
|
69499e3965 | ||
|
|
d67ced14c4 | ||
|
|
95ae69ead2 | ||
|
|
4170f13858 | ||
|
|
45e4a77afb | ||
|
|
603538e255 | ||
|
|
afb49f3666 | ||
|
|
c6de2ce8b8 | ||
|
|
cdc4229df7 | ||
|
|
fa19f7471f | ||
|
|
75f3af2cc1 | ||
|
|
5ae77ee57e | ||
|
|
6df5d72dfd | ||
|
|
b91b33e9be | ||
|
|
fd7226585b | ||
|
|
712b67b782 | ||
|
|
88ea30a6f8 | ||
|
|
f4cbe395d5 | ||
|
|
c59fb5dc1f | ||
|
|
c712ef28e8 | ||
|
|
c62a4a1c69 | ||
|
|
87a7cf202f | ||
|
|
9a9b424ff2 | ||
|
|
dfe6146aa3 | ||
|
|
8b26728914 | ||
|
|
f5003ac8ec | ||
|
|
ee71ba99e2 | ||
|
|
56c7a2dda2 | ||
|
|
e050f17945 | ||
|
|
8a60897086 | ||
|
|
e1dbab1517 | ||
|
|
ccc5f89ed7 | ||
|
|
06db1dd423 |
@@ -1,5 +1,47 @@
|
||||
# chat-rn-expo-clerk
|
||||
|
||||
## 1.0.111
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [80530a4]
|
||||
- jazz-tools@0.13.19
|
||||
- jazz-expo@0.13.19
|
||||
- jazz-react-native-media-images@0.13.19
|
||||
|
||||
## 1.0.110
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [761759c]
|
||||
- jazz-tools@0.13.18
|
||||
- jazz-expo@0.13.18
|
||||
- jazz-react-native-media-images@0.13.18
|
||||
|
||||
## 1.0.109
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-expo@0.13.17
|
||||
- jazz-tools@0.13.17
|
||||
- jazz-react-native-media-images@0.13.17
|
||||
|
||||
## 1.0.108
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-expo@0.13.16
|
||||
- jazz-tools@0.13.16
|
||||
- jazz-react-native-media-images@0.13.16
|
||||
|
||||
## 1.0.107
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-expo@0.13.15
|
||||
- jazz-tools@0.13.15
|
||||
- jazz-react-native-media-images@0.13.15
|
||||
|
||||
## 1.0.106
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "chat-rn-expo-clerk",
|
||||
"main": "index.js",
|
||||
"version": "1.0.106",
|
||||
"version": "1.0.111",
|
||||
"scripts": {
|
||||
"build": "expo export -p ios",
|
||||
"start": "expo start",
|
||||
|
||||
@@ -1,5 +1,42 @@
|
||||
# chat-rn-expo
|
||||
|
||||
## 1.0.98
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [80530a4]
|
||||
- jazz-tools@0.13.19
|
||||
- jazz-expo@0.13.19
|
||||
|
||||
## 1.0.97
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [761759c]
|
||||
- jazz-tools@0.13.18
|
||||
- jazz-expo@0.13.18
|
||||
|
||||
## 1.0.96
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-expo@0.13.17
|
||||
- jazz-tools@0.13.17
|
||||
|
||||
## 1.0.95
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-expo@0.13.16
|
||||
- jazz-tools@0.13.16
|
||||
|
||||
## 1.0.94
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-expo@0.13.15
|
||||
- jazz-tools@0.13.15
|
||||
|
||||
## 1.0.93
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "chat-rn-expo",
|
||||
"version": "1.0.93",
|
||||
"version": "1.0.98",
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
"build": "expo export -p ios",
|
||||
|
||||
@@ -20,6 +20,7 @@ import { Chat, Message } from "./schema";
|
||||
export default function ChatScreen({ navigation }: { navigation: any }) {
|
||||
const { me, logOut } = useAccount();
|
||||
const [chatId, setChatId] = useState<ID<Chat>>();
|
||||
const [chatIdInput, setChatIdInput] = useState<string>();
|
||||
const loadedChat = useCoState(Chat, chatId, { resolve: { $each: true } });
|
||||
const [message, setMessage] = useState("");
|
||||
const profile = useCoState(Profile, me._refs.profile?.id, {});
|
||||
@@ -57,27 +58,11 @@ export default function ChatScreen({ navigation }: { navigation: any }) {
|
||||
};
|
||||
|
||||
const joinChat = () => {
|
||||
Alert.prompt(
|
||||
"Join Chat",
|
||||
"Enter the Chat ID (example: co_zBGEHYvRfGuT2YSBraY3njGjnde)",
|
||||
[
|
||||
{
|
||||
text: "Cancel",
|
||||
style: "cancel",
|
||||
},
|
||||
{
|
||||
text: "Join",
|
||||
onPress: (chatId) => {
|
||||
if (chatId) {
|
||||
setChatId(chatId as ID<Chat>);
|
||||
} else {
|
||||
Alert.alert("Error", "Chat ID cannot be empty.");
|
||||
}
|
||||
},
|
||||
},
|
||||
],
|
||||
"plain-text",
|
||||
);
|
||||
if (chatIdInput) {
|
||||
setChatId(chatIdInput as ID<Chat>);
|
||||
} else {
|
||||
Alert.alert("Error", "Chat ID cannot be empty.");
|
||||
}
|
||||
};
|
||||
|
||||
const sendMessage = () => {
|
||||
@@ -160,9 +145,25 @@ export default function ChatScreen({ navigation }: { navigation: any }) {
|
||||
>
|
||||
<Text className="text-white font-semibold">Start new chat</Text>
|
||||
</TouchableOpacity>
|
||||
<Text className="text-m font-bold mt-6">Join existing chat</Text>
|
||||
<TextInput
|
||||
className="rounded h-12 p-2 m-2 mt-4 w-80 border border-gray-200 block"
|
||||
placeholder="Chat ID"
|
||||
value={chatIdInput ?? ""}
|
||||
onChangeText={(value) => {
|
||||
setChatIdInput(value);
|
||||
}}
|
||||
textAlignVertical="center"
|
||||
onSubmitEditing={() => {
|
||||
if (chatIdInput) {
|
||||
setChatId(chatIdInput as ID<Chat>);
|
||||
}
|
||||
}}
|
||||
testID="chat-id-input"
|
||||
/>
|
||||
<TouchableOpacity
|
||||
onPress={joinChat}
|
||||
className="bg-green-500 p-4 rounded-md mt-4"
|
||||
className="bg-green-500 p-4 rounded-md"
|
||||
>
|
||||
<Text className="text-white font-semibold">Join chat</Text>
|
||||
</TouchableOpacity>
|
||||
@@ -172,7 +173,6 @@ export default function ChatScreen({ navigation }: { navigation: any }) {
|
||||
<FlatList
|
||||
contentContainerStyle={{
|
||||
flexGrow: 1,
|
||||
flex: 1,
|
||||
gap: 6,
|
||||
padding: 8,
|
||||
}}
|
||||
|
||||
@@ -9,6 +9,8 @@ appId: com.jazz.chatrn
|
||||
# - tapOn: "Reload"
|
||||
|
||||
# login
|
||||
- assertVisible: "Logout"
|
||||
- tapOn: "Logout"
|
||||
- assertVisible: "Anonymous user"
|
||||
- runFlow:
|
||||
label: "Erase existing username"
|
||||
@@ -42,9 +44,11 @@ appId: com.jazz.chatrn
|
||||
# logout
|
||||
- tapOn: "Logout"
|
||||
- assertVisible: "Anonymous user"
|
||||
# This doesn't work on CI, maybe because Android has a different alert dialog
|
||||
# - tapOn: "Join chat"
|
||||
# - inputText: "co_zFs6KFyhxPw4xtw83tcEMzeHUNv" # Use a static id because maestro doesn't have access to the system clipboard
|
||||
# - pressKey: "enter"
|
||||
# - assertVisible: "boorad"
|
||||
# - assertVisible: "bro, low key, it do be like that tho"
|
||||
|
||||
# join chat
|
||||
- tapOn:
|
||||
id: "chat-id-input"
|
||||
- inputText: "co_zFs6KFyhxPw4xtw83tcEMzeHUNv" # Use a static id because maestro doesn't have access to the system clipboard
|
||||
- tapOn: "Join chat"
|
||||
- assertVisible: "boorad"
|
||||
- assertVisible: "bro, low key, it do be like that tho"
|
||||
|
||||
@@ -1,5 +1,58 @@
|
||||
# chat-rn
|
||||
|
||||
## 1.0.106
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [80530a4]
|
||||
- jazz-tools@0.13.19
|
||||
- jazz-react-native@0.13.19
|
||||
|
||||
## 1.0.105
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [9089252]
|
||||
- Updated dependencies [b470f63]
|
||||
- Updated dependencies [761759c]
|
||||
- Updated dependencies [66373ba]
|
||||
- Updated dependencies [f24cad1]
|
||||
- cojson@0.13.18
|
||||
- jazz-tools@0.13.18
|
||||
- cojson-transport-ws@0.13.18
|
||||
- jazz-react-native@0.13.18
|
||||
|
||||
## 1.0.104
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [9fb98e2]
|
||||
- Updated dependencies [0b89fad]
|
||||
- cojson@0.13.17
|
||||
- cojson-transport-ws@0.13.17
|
||||
- jazz-react-native@0.13.17
|
||||
- jazz-tools@0.13.17
|
||||
|
||||
## 1.0.103
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [c6fb8dc]
|
||||
- cojson@0.13.16
|
||||
- cojson-transport-ws@0.13.16
|
||||
- jazz-react-native@0.13.16
|
||||
- jazz-tools@0.13.16
|
||||
|
||||
## 1.0.102
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [c712ef2]
|
||||
- cojson@0.13.15
|
||||
- cojson-transport-ws@0.13.15
|
||||
- jazz-react-native@0.13.15
|
||||
- jazz-tools@0.13.15
|
||||
|
||||
## 1.0.101
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "chat-rn",
|
||||
"version": "1.0.101",
|
||||
"version": "1.0.106",
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
"android": "react-native run-android",
|
||||
|
||||
@@ -1,5 +1,47 @@
|
||||
# chat-vue
|
||||
|
||||
## 0.0.90
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [80530a4]
|
||||
- jazz-tools@0.13.19
|
||||
- jazz-browser@0.13.19
|
||||
- jazz-vue@0.13.19
|
||||
|
||||
## 0.0.89
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [761759c]
|
||||
- jazz-tools@0.13.18
|
||||
- jazz-browser@0.13.18
|
||||
- jazz-vue@0.13.18
|
||||
|
||||
## 0.0.88
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-browser@0.13.17
|
||||
- jazz-tools@0.13.17
|
||||
- jazz-vue@0.13.17
|
||||
|
||||
## 0.0.87
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-browser@0.13.16
|
||||
- jazz-tools@0.13.16
|
||||
- jazz-vue@0.13.16
|
||||
|
||||
## 0.0.86
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-browser@0.13.15
|
||||
- jazz-tools@0.13.15
|
||||
- jazz-vue@0.13.15
|
||||
|
||||
## 0.0.85
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "chat-vue",
|
||||
"version": "0.0.85",
|
||||
"version": "0.0.90",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
|
||||
@@ -1,5 +1,47 @@
|
||||
# jazz-example-chat
|
||||
|
||||
## 0.0.188
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [80530a4]
|
||||
- jazz-tools@0.13.19
|
||||
- jazz-inspector@0.13.19
|
||||
- jazz-react@0.13.19
|
||||
|
||||
## 0.0.187
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [761759c]
|
||||
- jazz-tools@0.13.18
|
||||
- jazz-inspector@0.13.18
|
||||
- jazz-react@0.13.18
|
||||
|
||||
## 0.0.186
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-inspector@0.13.17
|
||||
- jazz-react@0.13.17
|
||||
- jazz-tools@0.13.17
|
||||
|
||||
## 0.0.185
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-inspector@0.13.16
|
||||
- jazz-react@0.13.16
|
||||
- jazz-tools@0.13.16
|
||||
|
||||
## 0.0.184
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-inspector@0.13.15
|
||||
- jazz-react@0.13.15
|
||||
- jazz-tools@0.13.15
|
||||
|
||||
## 0.0.183
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "jazz-example-chat",
|
||||
"private": true,
|
||||
"version": "0.0.183",
|
||||
"version": "0.0.188",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "vite",
|
||||
|
||||
@@ -1,5 +1,47 @@
|
||||
# minimal-auth-clerk
|
||||
|
||||
## 0.0.87
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [80530a4]
|
||||
- jazz-tools@0.13.19
|
||||
- jazz-react@0.13.19
|
||||
- jazz-react-auth-clerk@0.13.19
|
||||
|
||||
## 0.0.86
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [761759c]
|
||||
- jazz-tools@0.13.18
|
||||
- jazz-react@0.13.18
|
||||
- jazz-react-auth-clerk@0.13.18
|
||||
|
||||
## 0.0.85
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.17
|
||||
- jazz-react-auth-clerk@0.13.17
|
||||
- jazz-tools@0.13.17
|
||||
|
||||
## 0.0.84
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.16
|
||||
- jazz-react-auth-clerk@0.13.16
|
||||
- jazz-tools@0.13.16
|
||||
|
||||
## 0.0.83
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.15
|
||||
- jazz-react-auth-clerk@0.13.15
|
||||
- jazz-tools@0.13.15
|
||||
|
||||
## 0.0.82
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "clerk",
|
||||
"private": true,
|
||||
"version": "0.0.82",
|
||||
"version": "0.0.87",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "vite",
|
||||
|
||||
@@ -1,5 +1,42 @@
|
||||
# file-share-svelte
|
||||
|
||||
## 0.0.70
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [80530a4]
|
||||
- jazz-tools@0.13.19
|
||||
- jazz-svelte@0.13.19
|
||||
|
||||
## 0.0.69
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [761759c]
|
||||
- jazz-tools@0.13.18
|
||||
- jazz-svelte@0.13.18
|
||||
|
||||
## 0.0.68
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-svelte@0.13.17
|
||||
- jazz-tools@0.13.17
|
||||
|
||||
## 0.0.67
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-svelte@0.13.16
|
||||
- jazz-tools@0.13.16
|
||||
|
||||
## 0.0.66
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-svelte@0.13.15
|
||||
- jazz-tools@0.13.15
|
||||
|
||||
## 0.0.65
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "file-share-svelte",
|
||||
"version": "0.0.65",
|
||||
"version": "0.0.70",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
const fileId = file._refs.file.id;
|
||||
|
||||
// Load the file as a blob, can take a while
|
||||
const blob = await FileStream.loadAsBlob(fileId, me, {});
|
||||
const blob = await FileStream.loadAsBlob(fileId);
|
||||
if (!blob) {
|
||||
toast.error('Failed to download file');
|
||||
return;
|
||||
|
||||
@@ -1,48 +1,26 @@
|
||||
<script lang="ts">
|
||||
import { useAccount, useCoState } from 'jazz-svelte';
|
||||
import { SharedFile, ListOfSharedFiles } from '$lib/schema';
|
||||
import { createInviteLink } from 'jazz-svelte';
|
||||
import { FileStream } from 'jazz-tools';
|
||||
import FileItem from '$lib/components/FileItem.svelte';
|
||||
import { SvelteMap } from 'svelte/reactivity';
|
||||
import { generateTempFileId } from '$lib/utils';
|
||||
import { CloudUpload } from 'lucide-svelte';
|
||||
|
||||
const { me, logOut } = useAccount();
|
||||
|
||||
const mySharedFilesId = me?.root?._refs.sharedFiles.id;
|
||||
const sharedFiles = $derived(useCoState(ListOfSharedFiles, mySharedFilesId, [{}]));
|
||||
const sharedFiles = $derived(useCoState(ListOfSharedFiles, mySharedFilesId));
|
||||
|
||||
let fileInput: HTMLInputElement;
|
||||
|
||||
type PendingSharedFile = {
|
||||
name: string;
|
||||
id: string;
|
||||
createdAt: Date;
|
||||
};
|
||||
|
||||
// Track files that are currently uploading
|
||||
const uploadingFiles = new SvelteMap<string, PendingSharedFile>();
|
||||
|
||||
async function handleFileUpload(event: Event) {
|
||||
const input = event.target as HTMLInputElement;
|
||||
const files = input.files;
|
||||
|
||||
if (!files || !files.length || !me.root?.sharedFiles || !me.root.publicGroup) return;
|
||||
if (!files || !files.length || !me?.root?.sharedFiles || !me?.root?.publicGroup) return;
|
||||
|
||||
const file = files[0];
|
||||
const fileName = file.name;
|
||||
const createdAt = new Date();
|
||||
const fileId = generateTempFileId(fileName, createdAt);
|
||||
|
||||
const tempFile: PendingSharedFile = {
|
||||
name: fileName,
|
||||
id: fileId,
|
||||
createdAt
|
||||
};
|
||||
|
||||
// Add to uploading files
|
||||
uploadingFiles.set(fileId, tempFile);
|
||||
|
||||
try {
|
||||
const ownership = { owner: me.root.publicGroup };
|
||||
@@ -65,17 +43,10 @@
|
||||
// Add the file to the user's files list
|
||||
me.root.sharedFiles.push(sharedFile);
|
||||
} finally {
|
||||
uploadingFiles.delete(fileId);
|
||||
fileInput.value = ''; // reset input
|
||||
}
|
||||
}
|
||||
|
||||
async function shareFile(file: SharedFile) {
|
||||
const inviteLink = createInviteLink(file, 'reader');
|
||||
await navigator.clipboard.writeText(inviteLink);
|
||||
alert('Share link copied to clipboard!');
|
||||
}
|
||||
|
||||
async function deleteFile(file: SharedFile) {
|
||||
if (!me?.root?.sharedFiles || !sharedFiles.current) return;
|
||||
|
||||
@@ -127,13 +98,11 @@
|
||||
<!-- Files List -->
|
||||
<div class="space-y-4">
|
||||
{#if sharedFiles.current}
|
||||
{#if !(sharedFiles.current.length === 0 && uploadingFiles.size === 0)}
|
||||
{#each [...sharedFiles.current, ...uploadingFiles.values()] as file (generateTempFileId(file?.name, file?.createdAt))}
|
||||
{#if !(sharedFiles.current.length === 0)}
|
||||
{#each sharedFiles.current as file}
|
||||
{#if file}
|
||||
<FileItem
|
||||
{file}
|
||||
loading={uploadingFiles.has(generateTempFileId(file?.name, file?.createdAt))}
|
||||
onShare={shareFile}
|
||||
onDelete={deleteFile}
|
||||
/>
|
||||
{/if}
|
||||
|
||||
@@ -1,5 +1,47 @@
|
||||
# jazz-tailwind-demo-auth-starter
|
||||
|
||||
## 0.0.27
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [80530a4]
|
||||
- jazz-tools@0.13.19
|
||||
- jazz-inspector@0.13.19
|
||||
- jazz-react@0.13.19
|
||||
|
||||
## 0.0.26
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [761759c]
|
||||
- jazz-tools@0.13.18
|
||||
- jazz-inspector@0.13.18
|
||||
- jazz-react@0.13.18
|
||||
|
||||
## 0.0.25
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-inspector@0.13.17
|
||||
- jazz-react@0.13.17
|
||||
- jazz-tools@0.13.17
|
||||
|
||||
## 0.0.24
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-inspector@0.13.16
|
||||
- jazz-react@0.13.16
|
||||
- jazz-tools@0.13.16
|
||||
|
||||
## 0.0.23
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-inspector@0.13.15
|
||||
- jazz-react@0.13.15
|
||||
- jazz-tools@0.13.15
|
||||
|
||||
## 0.0.22
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "filestream",
|
||||
"private": true,
|
||||
"version": "0.0.22",
|
||||
"version": "0.0.27",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "vite",
|
||||
|
||||
@@ -1,5 +1,42 @@
|
||||
# form
|
||||
|
||||
## 0.1.28
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [80530a4]
|
||||
- jazz-tools@0.13.19
|
||||
- jazz-react@0.13.19
|
||||
|
||||
## 0.1.27
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [761759c]
|
||||
- jazz-tools@0.13.18
|
||||
- jazz-react@0.13.18
|
||||
|
||||
## 0.1.26
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.17
|
||||
- jazz-tools@0.13.17
|
||||
|
||||
## 0.1.25
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.16
|
||||
- jazz-tools@0.13.16
|
||||
|
||||
## 0.1.24
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.15
|
||||
- jazz-tools@0.13.15
|
||||
|
||||
## 0.1.23
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "form",
|
||||
"private": true,
|
||||
"version": "0.1.23",
|
||||
"version": "0.1.28",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "vite",
|
||||
|
||||
@@ -1,5 +1,42 @@
|
||||
# image-upload
|
||||
|
||||
## 0.0.84
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [80530a4]
|
||||
- jazz-tools@0.13.19
|
||||
- jazz-react@0.13.19
|
||||
|
||||
## 0.0.83
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [761759c]
|
||||
- jazz-tools@0.13.18
|
||||
- jazz-react@0.13.18
|
||||
|
||||
## 0.0.82
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.17
|
||||
- jazz-tools@0.13.17
|
||||
|
||||
## 0.0.81
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.16
|
||||
- jazz-tools@0.13.16
|
||||
|
||||
## 0.0.80
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.15
|
||||
- jazz-tools@0.13.15
|
||||
|
||||
## 0.0.79
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "image-upload",
|
||||
"private": true,
|
||||
"version": "0.0.79",
|
||||
"version": "0.0.84",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "vite",
|
||||
|
||||
@@ -1,5 +1,51 @@
|
||||
# jazz-example-inspector
|
||||
|
||||
## 0.0.138
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-inspector@0.13.19
|
||||
|
||||
## 0.0.137
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [9089252]
|
||||
- Updated dependencies [b470f63]
|
||||
- Updated dependencies [66373ba]
|
||||
- Updated dependencies [f24cad1]
|
||||
- cojson@0.13.18
|
||||
- cojson-transport-ws@0.13.18
|
||||
- jazz-inspector@0.13.18
|
||||
|
||||
## 0.0.136
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [9fb98e2]
|
||||
- Updated dependencies [0b89fad]
|
||||
- cojson@0.13.17
|
||||
- cojson-transport-ws@0.13.17
|
||||
- jazz-inspector@0.13.17
|
||||
|
||||
## 0.0.135
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [c6fb8dc]
|
||||
- cojson@0.13.16
|
||||
- cojson-transport-ws@0.13.16
|
||||
- jazz-inspector@0.13.16
|
||||
|
||||
## 0.0.134
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [c712ef2]
|
||||
- cojson@0.13.15
|
||||
- cojson-transport-ws@0.13.15
|
||||
- jazz-inspector@0.13.15
|
||||
|
||||
## 0.0.133
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "jazz-inspector-app",
|
||||
"private": true,
|
||||
"version": "0.0.133",
|
||||
"version": "0.0.138",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "vite",
|
||||
|
||||
@@ -8,7 +8,9 @@
|
||||
"dev:worker": "tsx --watch --env-file=.env ./src/worker.ts",
|
||||
"build": "vite build && tsc",
|
||||
"serve": "vite preview",
|
||||
"generate-env": "tsx generate-env.ts"
|
||||
"generate-env": "tsx generate-env.ts",
|
||||
"format-and-lint": "biome check .",
|
||||
"format-and-lint:fix": "biome check . --write"
|
||||
},
|
||||
"dependencies": {
|
||||
"@radix-ui/react-label": "^2.1.2",
|
||||
|
||||
1
examples/jazz-paper-scissors/src/apiKey.ts
Normal file
1
examples/jazz-paper-scissors/src/apiKey.ts
Normal file
@@ -0,0 +1 @@
|
||||
export const apiKey = "jazz-paper-scissors@garden.co";
|
||||
@@ -3,6 +3,7 @@ import { StrictMode } from "react";
|
||||
import ReactDOM from "react-dom/client";
|
||||
|
||||
import "./index.css";
|
||||
import { apiKey } from "@/apiKey.ts";
|
||||
import { JazzProvider } from "jazz-react";
|
||||
import { App } from "./app";
|
||||
|
||||
@@ -13,7 +14,7 @@ if (rootElement && !rootElement.innerHTML) {
|
||||
<StrictMode>
|
||||
<JazzProvider
|
||||
sync={{
|
||||
peer: "wss://cloud.jazz.tools/?key=jazz-paper-scissors@garden.co",
|
||||
peer: `wss://cloud.jazz.tools/?key=${apiKey}`,
|
||||
}}
|
||||
>
|
||||
<JazzInspector />
|
||||
|
||||
@@ -10,139 +10,139 @@
|
||||
|
||||
// Import Routes
|
||||
|
||||
import { Route as rootRoute } from "./routes/__root";
|
||||
import { Route as AuthenticatedImport } from "./routes/_authenticated";
|
||||
import { Route as IndexImport } from "./routes/index";
|
||||
import { Route as AuthenticatedWaitingRoomWaitingRoomIdImport } from "./routes/_authenticated/waiting-room.$waitingRoomId";
|
||||
import { Route as AuthenticatedGameGameIdImport } from "./routes/_authenticated/game.$gameId";
|
||||
import { Route as rootRoute } from './routes/__root'
|
||||
import { Route as AuthenticatedImport } from './routes/_authenticated'
|
||||
import { Route as IndexImport } from './routes/index'
|
||||
import { Route as AuthenticatedWaitingRoomWaitingRoomIdImport } from './routes/_authenticated/waiting-room.$waitingRoomId'
|
||||
import { Route as AuthenticatedGameGameIdImport } from './routes/_authenticated/game.$gameId'
|
||||
|
||||
// Create/Update Routes
|
||||
|
||||
const AuthenticatedRoute = AuthenticatedImport.update({
|
||||
id: "/_authenticated",
|
||||
id: '/_authenticated',
|
||||
getParentRoute: () => rootRoute,
|
||||
} as any);
|
||||
} as any)
|
||||
|
||||
const IndexRoute = IndexImport.update({
|
||||
id: "/",
|
||||
path: "/",
|
||||
id: '/',
|
||||
path: '/',
|
||||
getParentRoute: () => rootRoute,
|
||||
} as any);
|
||||
} as any)
|
||||
|
||||
const AuthenticatedWaitingRoomWaitingRoomIdRoute =
|
||||
AuthenticatedWaitingRoomWaitingRoomIdImport.update({
|
||||
id: "/waiting-room/$waitingRoomId",
|
||||
path: "/waiting-room/$waitingRoomId",
|
||||
id: '/waiting-room/$waitingRoomId',
|
||||
path: '/waiting-room/$waitingRoomId',
|
||||
getParentRoute: () => AuthenticatedRoute,
|
||||
} as any);
|
||||
} as any)
|
||||
|
||||
const AuthenticatedGameGameIdRoute = AuthenticatedGameGameIdImport.update({
|
||||
id: "/game/$gameId",
|
||||
path: "/game/$gameId",
|
||||
id: '/game/$gameId',
|
||||
path: '/game/$gameId',
|
||||
getParentRoute: () => AuthenticatedRoute,
|
||||
} as any);
|
||||
} as any)
|
||||
|
||||
// Populate the FileRoutesByPath interface
|
||||
|
||||
declare module "@tanstack/react-router" {
|
||||
declare module '@tanstack/react-router' {
|
||||
interface FileRoutesByPath {
|
||||
"/": {
|
||||
id: "/";
|
||||
path: "/";
|
||||
fullPath: "/";
|
||||
preLoaderRoute: typeof IndexImport;
|
||||
parentRoute: typeof rootRoute;
|
||||
};
|
||||
"/_authenticated": {
|
||||
id: "/_authenticated";
|
||||
path: "";
|
||||
fullPath: "";
|
||||
preLoaderRoute: typeof AuthenticatedImport;
|
||||
parentRoute: typeof rootRoute;
|
||||
};
|
||||
"/_authenticated/game/$gameId": {
|
||||
id: "/_authenticated/game/$gameId";
|
||||
path: "/game/$gameId";
|
||||
fullPath: "/game/$gameId";
|
||||
preLoaderRoute: typeof AuthenticatedGameGameIdImport;
|
||||
parentRoute: typeof AuthenticatedImport;
|
||||
};
|
||||
"/_authenticated/waiting-room/$waitingRoomId": {
|
||||
id: "/_authenticated/waiting-room/$waitingRoomId";
|
||||
path: "/waiting-room/$waitingRoomId";
|
||||
fullPath: "/waiting-room/$waitingRoomId";
|
||||
preLoaderRoute: typeof AuthenticatedWaitingRoomWaitingRoomIdImport;
|
||||
parentRoute: typeof AuthenticatedImport;
|
||||
};
|
||||
'/': {
|
||||
id: '/'
|
||||
path: '/'
|
||||
fullPath: '/'
|
||||
preLoaderRoute: typeof IndexImport
|
||||
parentRoute: typeof rootRoute
|
||||
}
|
||||
'/_authenticated': {
|
||||
id: '/_authenticated'
|
||||
path: ''
|
||||
fullPath: ''
|
||||
preLoaderRoute: typeof AuthenticatedImport
|
||||
parentRoute: typeof rootRoute
|
||||
}
|
||||
'/_authenticated/game/$gameId': {
|
||||
id: '/_authenticated/game/$gameId'
|
||||
path: '/game/$gameId'
|
||||
fullPath: '/game/$gameId'
|
||||
preLoaderRoute: typeof AuthenticatedGameGameIdImport
|
||||
parentRoute: typeof AuthenticatedImport
|
||||
}
|
||||
'/_authenticated/waiting-room/$waitingRoomId': {
|
||||
id: '/_authenticated/waiting-room/$waitingRoomId'
|
||||
path: '/waiting-room/$waitingRoomId'
|
||||
fullPath: '/waiting-room/$waitingRoomId'
|
||||
preLoaderRoute: typeof AuthenticatedWaitingRoomWaitingRoomIdImport
|
||||
parentRoute: typeof AuthenticatedImport
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Create and export the route tree
|
||||
|
||||
interface AuthenticatedRouteChildren {
|
||||
AuthenticatedGameGameIdRoute: typeof AuthenticatedGameGameIdRoute;
|
||||
AuthenticatedWaitingRoomWaitingRoomIdRoute: typeof AuthenticatedWaitingRoomWaitingRoomIdRoute;
|
||||
AuthenticatedGameGameIdRoute: typeof AuthenticatedGameGameIdRoute
|
||||
AuthenticatedWaitingRoomWaitingRoomIdRoute: typeof AuthenticatedWaitingRoomWaitingRoomIdRoute
|
||||
}
|
||||
|
||||
const AuthenticatedRouteChildren: AuthenticatedRouteChildren = {
|
||||
AuthenticatedGameGameIdRoute: AuthenticatedGameGameIdRoute,
|
||||
AuthenticatedWaitingRoomWaitingRoomIdRoute:
|
||||
AuthenticatedWaitingRoomWaitingRoomIdRoute,
|
||||
};
|
||||
}
|
||||
|
||||
const AuthenticatedRouteWithChildren = AuthenticatedRoute._addFileChildren(
|
||||
AuthenticatedRouteChildren,
|
||||
);
|
||||
)
|
||||
|
||||
export interface FileRoutesByFullPath {
|
||||
"/": typeof IndexRoute;
|
||||
"": typeof AuthenticatedRouteWithChildren;
|
||||
"/game/$gameId": typeof AuthenticatedGameGameIdRoute;
|
||||
"/waiting-room/$waitingRoomId": typeof AuthenticatedWaitingRoomWaitingRoomIdRoute;
|
||||
'/': typeof IndexRoute
|
||||
'': typeof AuthenticatedRouteWithChildren
|
||||
'/game/$gameId': typeof AuthenticatedGameGameIdRoute
|
||||
'/waiting-room/$waitingRoomId': typeof AuthenticatedWaitingRoomWaitingRoomIdRoute
|
||||
}
|
||||
|
||||
export interface FileRoutesByTo {
|
||||
"/": typeof IndexRoute;
|
||||
"": typeof AuthenticatedRouteWithChildren;
|
||||
"/game/$gameId": typeof AuthenticatedGameGameIdRoute;
|
||||
"/waiting-room/$waitingRoomId": typeof AuthenticatedWaitingRoomWaitingRoomIdRoute;
|
||||
'/': typeof IndexRoute
|
||||
'': typeof AuthenticatedRouteWithChildren
|
||||
'/game/$gameId': typeof AuthenticatedGameGameIdRoute
|
||||
'/waiting-room/$waitingRoomId': typeof AuthenticatedWaitingRoomWaitingRoomIdRoute
|
||||
}
|
||||
|
||||
export interface FileRoutesById {
|
||||
__root__: typeof rootRoute;
|
||||
"/": typeof IndexRoute;
|
||||
"/_authenticated": typeof AuthenticatedRouteWithChildren;
|
||||
"/_authenticated/game/$gameId": typeof AuthenticatedGameGameIdRoute;
|
||||
"/_authenticated/waiting-room/$waitingRoomId": typeof AuthenticatedWaitingRoomWaitingRoomIdRoute;
|
||||
__root__: typeof rootRoute
|
||||
'/': typeof IndexRoute
|
||||
'/_authenticated': typeof AuthenticatedRouteWithChildren
|
||||
'/_authenticated/game/$gameId': typeof AuthenticatedGameGameIdRoute
|
||||
'/_authenticated/waiting-room/$waitingRoomId': typeof AuthenticatedWaitingRoomWaitingRoomIdRoute
|
||||
}
|
||||
|
||||
export interface FileRouteTypes {
|
||||
fileRoutesByFullPath: FileRoutesByFullPath;
|
||||
fullPaths: "/" | "" | "/game/$gameId" | "/waiting-room/$waitingRoomId";
|
||||
fileRoutesByTo: FileRoutesByTo;
|
||||
to: "/" | "" | "/game/$gameId" | "/waiting-room/$waitingRoomId";
|
||||
fileRoutesByFullPath: FileRoutesByFullPath
|
||||
fullPaths: '/' | '' | '/game/$gameId' | '/waiting-room/$waitingRoomId'
|
||||
fileRoutesByTo: FileRoutesByTo
|
||||
to: '/' | '' | '/game/$gameId' | '/waiting-room/$waitingRoomId'
|
||||
id:
|
||||
| "__root__"
|
||||
| "/"
|
||||
| "/_authenticated"
|
||||
| "/_authenticated/game/$gameId"
|
||||
| "/_authenticated/waiting-room/$waitingRoomId";
|
||||
fileRoutesById: FileRoutesById;
|
||||
| '__root__'
|
||||
| '/'
|
||||
| '/_authenticated'
|
||||
| '/_authenticated/game/$gameId'
|
||||
| '/_authenticated/waiting-room/$waitingRoomId'
|
||||
fileRoutesById: FileRoutesById
|
||||
}
|
||||
|
||||
export interface RootRouteChildren {
|
||||
IndexRoute: typeof IndexRoute;
|
||||
AuthenticatedRoute: typeof AuthenticatedRouteWithChildren;
|
||||
IndexRoute: typeof IndexRoute
|
||||
AuthenticatedRoute: typeof AuthenticatedRouteWithChildren
|
||||
}
|
||||
|
||||
const rootRouteChildren: RootRouteChildren = {
|
||||
IndexRoute: IndexRoute,
|
||||
AuthenticatedRoute: AuthenticatedRouteWithChildren,
|
||||
};
|
||||
}
|
||||
|
||||
export const routeTree = rootRoute
|
||||
._addFileChildren(rootRouteChildren)
|
||||
._addFileTypes<FileRouteTypes>();
|
||||
._addFileTypes<FileRouteTypes>()
|
||||
|
||||
/* ROUTE_MANIFEST_START
|
||||
{
|
||||
|
||||
@@ -1,5 +1,42 @@
|
||||
# multi-cursors
|
||||
|
||||
## 0.0.80
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [80530a4]
|
||||
- jazz-tools@0.13.19
|
||||
- jazz-react@0.13.19
|
||||
|
||||
## 0.0.79
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [761759c]
|
||||
- jazz-tools@0.13.18
|
||||
- jazz-react@0.13.18
|
||||
|
||||
## 0.0.78
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.17
|
||||
- jazz-tools@0.13.17
|
||||
|
||||
## 0.0.77
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.16
|
||||
- jazz-tools@0.13.16
|
||||
|
||||
## 0.0.76
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.15
|
||||
- jazz-tools@0.13.15
|
||||
|
||||
## 0.0.75
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "multi-cursors",
|
||||
"private": true,
|
||||
"version": "0.0.75",
|
||||
"version": "0.0.80",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "vite",
|
||||
|
||||
@@ -1,5 +1,47 @@
|
||||
# multiauth
|
||||
|
||||
## 0.0.28
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [80530a4]
|
||||
- jazz-tools@0.13.19
|
||||
- jazz-react@0.13.19
|
||||
- jazz-react-auth-clerk@0.13.19
|
||||
|
||||
## 0.0.27
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [761759c]
|
||||
- jazz-tools@0.13.18
|
||||
- jazz-react@0.13.18
|
||||
- jazz-react-auth-clerk@0.13.18
|
||||
|
||||
## 0.0.26
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.17
|
||||
- jazz-react-auth-clerk@0.13.17
|
||||
- jazz-tools@0.13.17
|
||||
|
||||
## 0.0.25
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.16
|
||||
- jazz-react-auth-clerk@0.13.16
|
||||
- jazz-tools@0.13.16
|
||||
|
||||
## 0.0.24
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.15
|
||||
- jazz-react-auth-clerk@0.13.15
|
||||
- jazz-tools@0.13.15
|
||||
|
||||
## 0.0.23
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "multiauth",
|
||||
"private": true,
|
||||
"version": "0.0.23",
|
||||
"version": "0.0.28",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "vite",
|
||||
|
||||
@@ -1,5 +1,47 @@
|
||||
# jazz-example-musicplayer
|
||||
|
||||
## 0.0.109
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [80530a4]
|
||||
- jazz-tools@0.13.19
|
||||
- jazz-inspector@0.13.19
|
||||
- jazz-react@0.13.19
|
||||
|
||||
## 0.0.108
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [761759c]
|
||||
- jazz-tools@0.13.18
|
||||
- jazz-inspector@0.13.18
|
||||
- jazz-react@0.13.18
|
||||
|
||||
## 0.0.107
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-inspector@0.13.17
|
||||
- jazz-react@0.13.17
|
||||
- jazz-tools@0.13.17
|
||||
|
||||
## 0.0.106
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-inspector@0.13.16
|
||||
- jazz-react@0.13.16
|
||||
- jazz-tools@0.13.16
|
||||
|
||||
## 0.0.105
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-inspector@0.13.15
|
||||
- jazz-react@0.13.15
|
||||
- jazz-tools@0.13.15
|
||||
|
||||
## 0.0.104
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "jazz-example-music-player",
|
||||
"private": true,
|
||||
"version": "0.0.104",
|
||||
"version": "0.0.109",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "vite",
|
||||
|
||||
@@ -1,5 +1,42 @@
|
||||
# organization
|
||||
|
||||
## 0.0.80
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [80530a4]
|
||||
- jazz-tools@0.13.19
|
||||
- jazz-react@0.13.19
|
||||
|
||||
## 0.0.79
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [761759c]
|
||||
- jazz-tools@0.13.18
|
||||
- jazz-react@0.13.18
|
||||
|
||||
## 0.0.78
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.17
|
||||
- jazz-tools@0.13.17
|
||||
|
||||
## 0.0.77
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.16
|
||||
- jazz-tools@0.13.16
|
||||
|
||||
## 0.0.76
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.15
|
||||
- jazz-tools@0.13.15
|
||||
|
||||
## 0.0.75
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "organization",
|
||||
"private": true,
|
||||
"version": "0.0.75",
|
||||
"version": "0.0.80",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "vite",
|
||||
|
||||
@@ -1,5 +1,42 @@
|
||||
# passkey-svelte
|
||||
|
||||
## 0.0.74
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [80530a4]
|
||||
- jazz-tools@0.13.19
|
||||
- jazz-svelte@0.13.19
|
||||
|
||||
## 0.0.73
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [761759c]
|
||||
- jazz-tools@0.13.18
|
||||
- jazz-svelte@0.13.18
|
||||
|
||||
## 0.0.72
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-svelte@0.13.17
|
||||
- jazz-tools@0.13.17
|
||||
|
||||
## 0.0.71
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-svelte@0.13.16
|
||||
- jazz-tools@0.13.16
|
||||
|
||||
## 0.0.70
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-svelte@0.13.15
|
||||
- jazz-tools@0.13.15
|
||||
|
||||
## 0.0.69
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "passkey-svelte",
|
||||
"version": "0.0.69",
|
||||
"version": "0.0.74",
|
||||
"type": "module",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
|
||||
@@ -1,5 +1,42 @@
|
||||
# minimal-auth-passkey
|
||||
|
||||
## 0.0.85
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [80530a4]
|
||||
- jazz-tools@0.13.19
|
||||
- jazz-react@0.13.19
|
||||
|
||||
## 0.0.84
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [761759c]
|
||||
- jazz-tools@0.13.18
|
||||
- jazz-react@0.13.18
|
||||
|
||||
## 0.0.83
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.17
|
||||
- jazz-tools@0.13.17
|
||||
|
||||
## 0.0.82
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.16
|
||||
- jazz-tools@0.13.16
|
||||
|
||||
## 0.0.81
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.15
|
||||
- jazz-tools@0.13.15
|
||||
|
||||
## 0.0.80
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "passkey",
|
||||
"private": true,
|
||||
"version": "0.0.80",
|
||||
"version": "0.0.85",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "vite",
|
||||
|
||||
@@ -1,5 +1,42 @@
|
||||
# passphrase
|
||||
|
||||
## 0.0.82
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [80530a4]
|
||||
- jazz-tools@0.13.19
|
||||
- jazz-react@0.13.19
|
||||
|
||||
## 0.0.81
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [761759c]
|
||||
- jazz-tools@0.13.18
|
||||
- jazz-react@0.13.18
|
||||
|
||||
## 0.0.80
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.17
|
||||
- jazz-tools@0.13.17
|
||||
|
||||
## 0.0.79
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.16
|
||||
- jazz-tools@0.13.16
|
||||
|
||||
## 0.0.78
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.15
|
||||
- jazz-tools@0.13.15
|
||||
|
||||
## 0.0.77
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "passphrase",
|
||||
"private": true,
|
||||
"version": "0.0.77",
|
||||
"version": "0.0.82",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "vite",
|
||||
|
||||
@@ -1,5 +1,42 @@
|
||||
# jazz-password-manager
|
||||
|
||||
## 0.0.106
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [80530a4]
|
||||
- jazz-tools@0.13.19
|
||||
- jazz-react@0.13.19
|
||||
|
||||
## 0.0.105
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [761759c]
|
||||
- jazz-tools@0.13.18
|
||||
- jazz-react@0.13.18
|
||||
|
||||
## 0.0.104
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.17
|
||||
- jazz-tools@0.13.17
|
||||
|
||||
## 0.0.103
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.16
|
||||
- jazz-tools@0.13.16
|
||||
|
||||
## 0.0.102
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.15
|
||||
- jazz-tools@0.13.15
|
||||
|
||||
## 0.0.101
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "jazz-password-manager",
|
||||
"private": true,
|
||||
"version": "0.0.101",
|
||||
"version": "0.0.106",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "vite",
|
||||
|
||||
@@ -1,5 +1,42 @@
|
||||
# jazz-example-pets
|
||||
|
||||
## 0.0.204
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [80530a4]
|
||||
- jazz-tools@0.13.19
|
||||
- jazz-react@0.13.19
|
||||
|
||||
## 0.0.203
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [761759c]
|
||||
- jazz-tools@0.13.18
|
||||
- jazz-react@0.13.18
|
||||
|
||||
## 0.0.202
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.17
|
||||
- jazz-tools@0.13.17
|
||||
|
||||
## 0.0.201
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.16
|
||||
- jazz-tools@0.13.16
|
||||
|
||||
## 0.0.200
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.15
|
||||
- jazz-tools@0.13.15
|
||||
|
||||
## 0.0.199
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "jazz-example-pets",
|
||||
"private": true,
|
||||
"version": "0.0.199",
|
||||
"version": "0.0.204",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "vite",
|
||||
|
||||
@@ -1,5 +1,42 @@
|
||||
# reactions
|
||||
|
||||
## 0.0.84
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [80530a4]
|
||||
- jazz-tools@0.13.19
|
||||
- jazz-react@0.13.19
|
||||
|
||||
## 0.0.83
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [761759c]
|
||||
- jazz-tools@0.13.18
|
||||
- jazz-react@0.13.18
|
||||
|
||||
## 0.0.82
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.17
|
||||
- jazz-tools@0.13.17
|
||||
|
||||
## 0.0.81
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.16
|
||||
- jazz-tools@0.13.16
|
||||
|
||||
## 0.0.80
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.15
|
||||
- jazz-tools@0.13.15
|
||||
|
||||
## 0.0.79
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "reactions",
|
||||
"private": true,
|
||||
"version": "0.0.79",
|
||||
"version": "0.0.84",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "vite",
|
||||
|
||||
@@ -1,5 +1,49 @@
|
||||
# richtext
|
||||
|
||||
## 0.0.74
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [80530a4]
|
||||
- jazz-tools@0.13.19
|
||||
- jazz-react@0.13.19
|
||||
- jazz-richtext-prosemirror@0.1.8
|
||||
|
||||
## 0.0.73
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [761759c]
|
||||
- Updated dependencies [133b8ab]
|
||||
- jazz-tools@0.13.18
|
||||
- jazz-richtext-prosemirror@0.1.7
|
||||
- jazz-react@0.13.18
|
||||
|
||||
## 0.0.72
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [133b8ab]
|
||||
- jazz-richtext-prosemirror@0.1.6
|
||||
- jazz-react@0.13.17
|
||||
- jazz-tools@0.13.17
|
||||
|
||||
## 0.0.71
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.16
|
||||
- jazz-tools@0.13.16
|
||||
- jazz-richtext-prosemirror@0.1.5
|
||||
|
||||
## 0.0.70
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.15
|
||||
- jazz-tools@0.13.15
|
||||
- jazz-richtext-prosemirror@0.1.4
|
||||
|
||||
## 0.0.69
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -2,6 +2,8 @@
|
||||
|
||||
A demonstration of collaborative rich text editing with Jazz, React, and ProseMirror.
|
||||
|
||||
Live version: [https://richtext-demo.jazz.tools](https://richtext-demo.jazz.tools)
|
||||
|
||||
## Overview
|
||||
|
||||
This example shows how to implement collaborative rich text editing using:
|
||||
@@ -16,23 +18,52 @@ The example features:
|
||||
- Side-by-side plaintext and rich text editors
|
||||
- Real-time collaboration across devices
|
||||
- Persistent document storage
|
||||
## Getting started
|
||||
|
||||
## Running locally
|
||||
You can either
|
||||
1. Clone the jazz repository, and run the app within the monorepo.
|
||||
2. Or create a new Jazz project using this example as a template.
|
||||
|
||||
Install dependencies:
|
||||
|
||||
### Using the example as a template
|
||||
|
||||
Create a new Jazz project, and use this example as a template.
|
||||
```bash
|
||||
npm i
|
||||
# or
|
||||
yarn
|
||||
npx create-jazz-app@latest richtext-app --example richtext
|
||||
```
|
||||
|
||||
Then, run the development server:
|
||||
Go to the new project directory.
|
||||
```bash
|
||||
cd richtext-app
|
||||
```
|
||||
|
||||
Run the dev server.
|
||||
```bash
|
||||
npm run dev
|
||||
# or
|
||||
yarn dev
|
||||
```
|
||||
|
||||
### Using the monorepo
|
||||
|
||||
This requires `pnpm` to be installed, see [https://pnpm.io/installation](https://pnpm.io/installation).
|
||||
|
||||
Clone the jazz repository.
|
||||
```bash
|
||||
git clone https://github.com/garden-co/jazz.git
|
||||
```
|
||||
|
||||
Install and build dependencies.
|
||||
```bash
|
||||
pnpm i && npx turbo build
|
||||
```
|
||||
|
||||
Go to the example directory.
|
||||
```bash
|
||||
cd jazz/examples/richtext/
|
||||
```
|
||||
|
||||
Start the dev server.
|
||||
```bash
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
Open [http://localhost:5173](http://localhost:5173) with your browser to see the result.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "richtext",
|
||||
"private": true,
|
||||
"version": "0.0.69",
|
||||
"version": "0.0.74",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "vite",
|
||||
@@ -19,6 +19,7 @@
|
||||
"prosemirror-example-setup": "^1.2.3",
|
||||
"prosemirror-model": "^1.25.0",
|
||||
"prosemirror-schema-basic": "^1.2.4",
|
||||
"prosemirror-schema-list": "^1.5.1",
|
||||
"prosemirror-state": "^1.4.3",
|
||||
"prosemirror-view": "^1.39.1",
|
||||
"react": "18.3.1",
|
||||
|
||||
@@ -1,7 +1,9 @@
|
||||
import { useAccount } from "jazz-react";
|
||||
import { createJazzPlugin } from "jazz-richtext-prosemirror";
|
||||
import { exampleSetup } from "prosemirror-example-setup";
|
||||
import { schema } from "prosemirror-schema-basic";
|
||||
import { Schema } from "prosemirror-model";
|
||||
import { schema as basicSchema } from "prosemirror-schema-basic";
|
||||
import { addListNodes } from "prosemirror-schema-list";
|
||||
import { EditorState } from "prosemirror-state";
|
||||
import { EditorView } from "prosemirror-view";
|
||||
import { useEffect, useRef } from "react";
|
||||
@@ -14,6 +16,11 @@ export function Editor() {
|
||||
useEffect(() => {
|
||||
if (!me || !editorRef.current || !me.profile.bio) return;
|
||||
|
||||
const schema = new Schema({
|
||||
nodes: addListNodes(basicSchema.spec.nodes, "paragraph block*", "block"),
|
||||
marks: basicSchema.spec.marks,
|
||||
});
|
||||
|
||||
const setupPlugins = exampleSetup({ schema });
|
||||
const jazzPlugin = createJazzPlugin(me.profile.bio);
|
||||
|
||||
|
||||
@@ -1,3 +1,10 @@
|
||||
@tailwind base;
|
||||
@tailwind components;
|
||||
@tailwind utilities;
|
||||
|
||||
.ProseMirror ul {
|
||||
@apply list-disc;
|
||||
}
|
||||
.ProseMirror ol {
|
||||
@apply list-decimal;
|
||||
}
|
||||
|
||||
@@ -1,5 +1,47 @@
|
||||
# todo-vue
|
||||
|
||||
## 0.0.88
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [80530a4]
|
||||
- jazz-tools@0.13.19
|
||||
- jazz-browser@0.13.19
|
||||
- jazz-vue@0.13.19
|
||||
|
||||
## 0.0.87
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [761759c]
|
||||
- jazz-tools@0.13.18
|
||||
- jazz-browser@0.13.18
|
||||
- jazz-vue@0.13.18
|
||||
|
||||
## 0.0.86
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-browser@0.13.17
|
||||
- jazz-tools@0.13.17
|
||||
- jazz-vue@0.13.17
|
||||
|
||||
## 0.0.85
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-browser@0.13.16
|
||||
- jazz-tools@0.13.16
|
||||
- jazz-vue@0.13.16
|
||||
|
||||
## 0.0.84
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-browser@0.13.15
|
||||
- jazz-tools@0.13.15
|
||||
- jazz-vue@0.13.15
|
||||
|
||||
## 0.0.83
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "todo-vue",
|
||||
"version": "0.0.83",
|
||||
"version": "0.0.88",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
|
||||
@@ -1,5 +1,42 @@
|
||||
# jazz-example-todo
|
||||
|
||||
## 0.0.203
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [80530a4]
|
||||
- jazz-tools@0.13.19
|
||||
- jazz-react@0.13.19
|
||||
|
||||
## 0.0.202
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [761759c]
|
||||
- jazz-tools@0.13.18
|
||||
- jazz-react@0.13.18
|
||||
|
||||
## 0.0.201
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.17
|
||||
- jazz-tools@0.13.17
|
||||
|
||||
## 0.0.200
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.16
|
||||
- jazz-tools@0.13.16
|
||||
|
||||
## 0.0.199
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-react@0.13.15
|
||||
- jazz-tools@0.13.15
|
||||
|
||||
## 0.0.198
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "jazz-example-todo",
|
||||
"private": true,
|
||||
"version": "0.0.198",
|
||||
"version": "0.0.203",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "vite",
|
||||
@@ -11,6 +11,7 @@
|
||||
"preview": "vite preview"
|
||||
},
|
||||
"dependencies": {
|
||||
"@faker-js/faker": "^9.7.0",
|
||||
"@radix-ui/react-checkbox": "^1.0.4",
|
||||
"@radix-ui/react-slot": "^1.1.1",
|
||||
"@radix-ui/react-toast": "^1.1.4",
|
||||
|
||||
@@ -41,12 +41,9 @@ export class TodoAccount extends Account {
|
||||
*/
|
||||
migrate() {
|
||||
if (!this._refs.root) {
|
||||
this.root = TodoAccountRoot.create(
|
||||
{
|
||||
projects: ListOfProjects.create([], { owner: this }),
|
||||
},
|
||||
{ owner: this },
|
||||
);
|
||||
this.root = TodoAccountRoot.create({
|
||||
projects: ListOfProjects.create([]),
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -23,6 +23,7 @@ import {
|
||||
ThemeProvider,
|
||||
TitleAndLogo,
|
||||
} from "./basicComponents/index.ts";
|
||||
import { TaskGenerator } from "./components/TaskGenerator.tsx";
|
||||
import { wordlist } from "./wordlist.ts";
|
||||
|
||||
/**
|
||||
@@ -95,6 +96,10 @@ export default function App() {
|
||||
path: "/invite/*",
|
||||
element: <p>Accepting invite...</p>,
|
||||
},
|
||||
{
|
||||
path: "/generate",
|
||||
element: <TaskGenerator />,
|
||||
},
|
||||
]);
|
||||
|
||||
// `useAcceptInvite()` is a hook that accepts an invite link from the URL hash,
|
||||
|
||||
@@ -35,7 +35,11 @@ export function ProjectTodoTable() {
|
||||
// content - whether we create edits locally, load persisted data, or receive
|
||||
// sync updates from other devices or participants!
|
||||
// It also recursively resolves and subsribes to all referenced CoValues.
|
||||
const project = useCoState(TodoProject, projectId);
|
||||
const project = useCoState(TodoProject, projectId, {
|
||||
resolve: {
|
||||
tasks: true,
|
||||
},
|
||||
});
|
||||
|
||||
// `createTask` is similar to `createProject` we saw earlier, creating a new CoMap
|
||||
// for a new task (in the same group as the project), and then
|
||||
|
||||
61
examples/todo/src/components/TaskGenerator.tsx
Normal file
61
examples/todo/src/components/TaskGenerator.tsx
Normal file
@@ -0,0 +1,61 @@
|
||||
import { TodoAccount } from "@/1_schema";
|
||||
import { FormEvent, useState } from "react";
|
||||
import { useNavigate } from "react-router-dom";
|
||||
import { generateRandomProject } from "../generate";
|
||||
|
||||
export function TaskGenerator() {
|
||||
const [isGenerating, setIsGenerating] = useState(false);
|
||||
const navigate = useNavigate();
|
||||
|
||||
const handleSubmit = async (e: FormEvent<HTMLFormElement>) => {
|
||||
e.preventDefault();
|
||||
const formData = new FormData(e.currentTarget);
|
||||
const numTasks = Math.max(
|
||||
1,
|
||||
parseInt(formData.get("numTasks") as string) || 1,
|
||||
);
|
||||
|
||||
setIsGenerating(true);
|
||||
const project = generateRandomProject(numTasks);
|
||||
|
||||
const { root } = await TodoAccount.getMe().ensureLoaded({
|
||||
resolve: {
|
||||
root: {
|
||||
projects: true,
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
root.projects.push(project);
|
||||
|
||||
navigate(`/project/${project.id}`);
|
||||
};
|
||||
|
||||
return (
|
||||
<div className="p-4 border rounded-lg shadow-sm bg-white">
|
||||
<h2 className="text-lg font-semibold mb-4">Generate Random Tasks</h2>
|
||||
<form onSubmit={handleSubmit} className="flex flex-col gap-4">
|
||||
<div className="flex items-center gap-2">
|
||||
<label htmlFor="numTasks" className="text-sm font-medium">
|
||||
Number of tasks:
|
||||
</label>
|
||||
<input
|
||||
id="numTasks"
|
||||
name="numTasks"
|
||||
type="number"
|
||||
min="1"
|
||||
defaultValue={5}
|
||||
className="w-20 px-2 py-1 border rounded"
|
||||
/>
|
||||
</div>
|
||||
<button
|
||||
type="submit"
|
||||
disabled={isGenerating}
|
||||
className="px-4 py-2 bg-blue-500 text-white rounded hover:bg-blue-600 disabled:bg-blue-300"
|
||||
>
|
||||
{isGenerating ? "Generating..." : "Generate Tasks"}
|
||||
</button>
|
||||
</form>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
25
examples/todo/src/generate.ts
Normal file
25
examples/todo/src/generate.ts
Normal file
@@ -0,0 +1,25 @@
|
||||
import { faker } from "@faker-js/faker";
|
||||
import { ListOfTasks, Task, TodoProject } from "./1_schema";
|
||||
|
||||
export function generateRandomProject(numTasks: number): TodoProject {
|
||||
// Generate a random project title
|
||||
const projectTitle = faker.company.catchPhrase();
|
||||
|
||||
// Create a list of tasks
|
||||
const tasks = ListOfTasks.create([]);
|
||||
|
||||
// Generate random tasks
|
||||
for (let i = 0; i < numTasks; i++) {
|
||||
const task = Task.create({
|
||||
done: faker.datatype.boolean(),
|
||||
text: faker.lorem.sentence({ min: 3, max: 8 }),
|
||||
});
|
||||
tasks.push(task);
|
||||
}
|
||||
|
||||
// Create and return the project
|
||||
return TodoProject.create({
|
||||
title: projectTitle,
|
||||
tasks: tasks,
|
||||
});
|
||||
}
|
||||
@@ -1,5 +1,47 @@
|
||||
# version-history
|
||||
|
||||
## 0.0.82
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [80530a4]
|
||||
- jazz-tools@0.13.19
|
||||
- jazz-inspector@0.13.19
|
||||
- jazz-react@0.13.19
|
||||
|
||||
## 0.0.81
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [761759c]
|
||||
- jazz-tools@0.13.18
|
||||
- jazz-inspector@0.13.18
|
||||
- jazz-react@0.13.18
|
||||
|
||||
## 0.0.80
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-inspector@0.13.17
|
||||
- jazz-react@0.13.17
|
||||
- jazz-tools@0.13.17
|
||||
|
||||
## 0.0.79
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-inspector@0.13.16
|
||||
- jazz-react@0.13.16
|
||||
- jazz-tools@0.13.16
|
||||
|
||||
## 0.0.78
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- jazz-inspector@0.13.15
|
||||
- jazz-react@0.13.15
|
||||
- jazz-tools@0.13.15
|
||||
|
||||
## 0.0.77
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "version-history",
|
||||
"private": true,
|
||||
"version": "0.0.77",
|
||||
"version": "0.0.82",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "vite",
|
||||
|
||||
@@ -2,6 +2,7 @@ import {
|
||||
AlertTriangleIcon,
|
||||
ArrowDownIcon,
|
||||
ArrowRightIcon,
|
||||
BoldIcon,
|
||||
BookTextIcon,
|
||||
BoxIcon,
|
||||
BracesIcon,
|
||||
@@ -20,6 +21,7 @@ import {
|
||||
HashIcon,
|
||||
ImageIcon,
|
||||
InfoIcon,
|
||||
ItalicIcon,
|
||||
LinkIcon,
|
||||
LockKeyholeIcon,
|
||||
type LucideIcon,
|
||||
@@ -87,6 +89,10 @@ const icons = {
|
||||
colist: Brackets,
|
||||
user: UserIcon,
|
||||
group: UsersIcon,
|
||||
|
||||
// text editor icons
|
||||
bold: BoldIcon,
|
||||
italic: ItalicIcon,
|
||||
};
|
||||
|
||||
// copied from tailwind line height https://tailwindcss.com/docs/font-size
|
||||
|
||||
@@ -22,7 +22,7 @@ export function JazzLogo({
|
||||
fillRule="evenodd"
|
||||
clipRule="evenodd"
|
||||
d="M136.179 44.8277C136.179 44.8277 136.179 44.8277 136.179 44.8276V21.168C117.931 28.5527 97.9854 32.6192 77.0897 32.6192C65.1466 32.6192 53.5138 31.2908 42.331 28.7737V51.4076C42.331 51.4076 42.331 51.4076 42.331 51.4076V81.1508C41.2955 80.4385 40.1568 79.8458 38.9405 79.3915C36.1732 78.358 33.128 78.0876 30.1902 78.6145C27.2524 79.1414 24.5539 80.4419 22.4358 82.3516C20.3178 84.2613 18.8754 86.6944 18.291 89.3433C17.7066 91.9921 18.0066 94.7377 19.1528 97.2329C20.2991 99.728 22.2403 101.861 24.7308 103.361C27.2214 104.862 30.1495 105.662 33.1448 105.662H33.1455C33.6061 105.662 33.8365 105.662 34.0314 105.659C44.5583 105.449 53.042 96.9656 53.2513 86.4386C53.2534 86.3306 53.2544 86.2116 53.2548 86.0486H53.2552V85.7149L53.2552 85.5521V82.0762L53.2552 53.1993C61.0533 54.2324 69.0092 54.7656 77.0897 54.7656C77.6696 54.7656 78.2489 54.7629 78.8276 54.7574V110.696C77.792 109.983 76.6533 109.391 75.437 108.936C72.6697 107.903 69.6246 107.632 66.6867 108.159C63.7489 108.686 61.0504 109.987 58.9323 111.896C56.8143 113.806 55.3719 116.239 54.7875 118.888C54.2032 121.537 54.5031 124.283 55.6494 126.778C56.7956 129.273 58.7368 131.405 61.2273 132.906C63.7179 134.406 66.646 135.207 69.6414 135.207C70.1024 135.207 70.3329 135.207 70.5279 135.203C81.0548 134.994 89.5385 126.51 89.7478 115.983C89.7517 115.788 89.7517 115.558 89.7517 115.097V111.621L89.7517 54.3266C101.962 53.4768 113.837 51.4075 125.255 48.2397V80.9017C124.219 80.1894 123.081 79.5966 121.864 79.1424C119.097 78.1089 116.052 77.8384 113.114 78.3653C110.176 78.8922 107.478 80.1927 105.36 82.1025C103.242 84.0122 101.799 86.4453 101.215 89.0941C100.631 91.743 100.931 94.4886 102.077 96.9837C103.223 99.4789 105.164 101.612 107.655 103.112C110.145 104.612 113.073 105.413 116.069 105.413C116.53 105.413 116.76 105.413 116.955 105.409C127.482 105.2 135.966 96.7164 136.175 86.1895C136.179 85.9945 136.179 85.764 136.179 85.3029V81.8271L136.179 44.8277Z"
|
||||
className="fill-primary"
|
||||
fill="#146AFF"
|
||||
/>
|
||||
</svg>
|
||||
);
|
||||
|
||||
@@ -1,5 +1,3 @@
|
||||
import { readFile } from "node:fs/promises";
|
||||
import { join } from "node:path";
|
||||
import { ImageResponse } from "next/og";
|
||||
import { JazzLogo } from "../atoms/logos/JazzLogo";
|
||||
|
||||
@@ -10,28 +8,112 @@ export const imageSize = {
|
||||
|
||||
export const imageContentType = "image/png";
|
||||
|
||||
export default async function OpenGraphImage({ title }: { title: string }) {
|
||||
const manropeSemiBold = await readFile(
|
||||
join(process.cwd(), "public/fonts/Manrope-SemiBold.ttf"),
|
||||
async function loadManropeGoogleFont() {
|
||||
const url = `https://fonts.googleapis.com/css2?family=Manrope:wght@600`;
|
||||
const css = await (await fetch(url)).text();
|
||||
const resource = css.match(
|
||||
/src: url\((.+)\) format\('(opentype|truetype)'\)/,
|
||||
);
|
||||
|
||||
if (resource) {
|
||||
const response = await fetch(resource[1]);
|
||||
if (response.status == 200) {
|
||||
return await response.arrayBuffer();
|
||||
}
|
||||
}
|
||||
|
||||
throw new Error("failed to load font data");
|
||||
}
|
||||
|
||||
export async function OpenGraphImage({
|
||||
title,
|
||||
framework,
|
||||
contents,
|
||||
topic,
|
||||
subtopic,
|
||||
}: {
|
||||
title: string;
|
||||
framework?: string;
|
||||
contents?: string[];
|
||||
topic?: string;
|
||||
subtopic?: string;
|
||||
}) {
|
||||
if (!title) {
|
||||
throw new Error(
|
||||
`No title from tocItems in opengraph-image.tsx ${framework} ${topic} ${subtopic}`,
|
||||
);
|
||||
}
|
||||
|
||||
return new ImageResponse(
|
||||
<div
|
||||
style={{
|
||||
fontSize: "7em",
|
||||
background: "white",
|
||||
width: "100%",
|
||||
height: "100%",
|
||||
display: "flex",
|
||||
alignItems: "center",
|
||||
justifyContent: "flex-start",
|
||||
flexDirection: "column",
|
||||
alignItems: "flex-start",
|
||||
justifyContent: "center",
|
||||
padding: "77px",
|
||||
letterSpacing: "-0.05em",
|
||||
}}
|
||||
>
|
||||
{title}
|
||||
<div
|
||||
style={{ display: "flex", position: "absolute", bottom: 35, right: 45 }}
|
||||
style={{
|
||||
display: "flex",
|
||||
flexDirection: "column",
|
||||
alignItems: "center",
|
||||
gap: "1rem",
|
||||
fontSize: "4rem",
|
||||
}}
|
||||
>
|
||||
{title}
|
||||
</div>
|
||||
<div
|
||||
style={{
|
||||
position: "absolute",
|
||||
right: 15,
|
||||
top: 10,
|
||||
display: "flex",
|
||||
alignItems: "center",
|
||||
justifyContent: "flex-start",
|
||||
fontSize: "3rem",
|
||||
color: "#888888",
|
||||
letterSpacing: "-0.03em",
|
||||
}}
|
||||
>
|
||||
<div style={{ display: "flex", color: "#BBB", paddingRight: "0.5rem" }}>
|
||||
{framework}
|
||||
</div>
|
||||
{topic && (
|
||||
<span style={{ color: "#CCC", paddingRight: "0.5rem" }}>
|
||||
/ {topic}
|
||||
</span>
|
||||
)}
|
||||
{subtopic && <span style={{ color: "#DDD" }}>/ {subtopic}</span>}
|
||||
</div>
|
||||
<div
|
||||
style={{
|
||||
display: "flex",
|
||||
flexDirection: "column",
|
||||
marginTop: "1rem",
|
||||
gap: "0.2rem",
|
||||
fontSize: "2rem",
|
||||
color: "#888888",
|
||||
letterSpacing: "-0.03em",
|
||||
}}
|
||||
>
|
||||
{contents?.map((content) => (
|
||||
<div key={content}>{content}</div>
|
||||
))}
|
||||
</div>
|
||||
<div
|
||||
style={{
|
||||
display: "flex",
|
||||
position: "absolute",
|
||||
bottom: 35,
|
||||
right: 45,
|
||||
}}
|
||||
>
|
||||
<JazzLogo width={193} height={73} />
|
||||
</div>
|
||||
@@ -41,7 +123,9 @@ export default async function OpenGraphImage({ title }: { title: string }) {
|
||||
fonts: [
|
||||
{
|
||||
name: "Manrope",
|
||||
data: manropeSemiBold,
|
||||
data: await loadManropeGoogleFont(),
|
||||
style: "normal",
|
||||
weight: 600,
|
||||
},
|
||||
],
|
||||
},
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { packages } from "@/content/packages";
|
||||
import { clsx } from "clsx";
|
||||
import { Icon } from "@garden-co/design-system/src/components/atoms/Icon";
|
||||
import { clsx } from "clsx";
|
||||
import type { Metadata } from "next";
|
||||
import Link from "next/link";
|
||||
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
import { OpenGraphImage, imageSize, imageContentType } from '@garden-co/design-system/src/components/organisms/OpenGraphImage';
|
||||
import { getMdxWithToc } from '@/lib/docMdxContent';
|
||||
export const title = "Quickstart";
|
||||
export const size = imageSize;
|
||||
export const contentType = imageContentType;
|
||||
export const alt = "Quickstart";
|
||||
|
||||
export default async function Image({ params }: { params: Promise<{ framework: string, topic: string, subtopic: string }> }) {
|
||||
const { framework, topic, subtopic } = await params;
|
||||
const { tocItems } = await getMdxWithToc(framework, [topic, subtopic]);
|
||||
|
||||
const title = tocItems[0]?.value;
|
||||
|
||||
if (!title) {
|
||||
throw new Error(`No title from tocItems in opengraph-image.tsx ${framework} ${topic} ${subtopic}`);
|
||||
}
|
||||
|
||||
return OpenGraphImage({
|
||||
title: title,
|
||||
framework,
|
||||
contents: tocItems[0]?.children?.map((child) => child.value) ?? [],
|
||||
topic,
|
||||
subtopic,
|
||||
});
|
||||
}
|
||||
@@ -0,0 +1,26 @@
|
||||
import { OpenGraphImage, imageSize, imageContentType } from '@garden-co/design-system/src/components/organisms/OpenGraphImage';
|
||||
import { getMdxWithToc } from '@/lib/docMdxContent';
|
||||
export const title = "Quickstart";
|
||||
export const size = imageSize;
|
||||
export const contentType = imageContentType;
|
||||
export const alt = "Quickstart";
|
||||
|
||||
export default async function Image({ params }: { params: Promise<{ framework: string, topic: string }> }) {
|
||||
const { framework, topic } = await params;
|
||||
const { tocItems } = await getMdxWithToc(framework, [topic]);
|
||||
|
||||
// console.log('tocItems', tocItems);
|
||||
|
||||
const title = tocItems[0]?.value;
|
||||
|
||||
if (!title) {
|
||||
throw new Error(`No title from tocItems in opengraph-image.tsx ${framework} ${topic}`);
|
||||
}
|
||||
|
||||
return OpenGraphImage({
|
||||
title: title,
|
||||
framework,
|
||||
contents: tocItems[0]?.children?.map((child) => child.value) ?? [],
|
||||
topic,
|
||||
});
|
||||
}
|
||||
@@ -0,0 +1,32 @@
|
||||
import { getMdxWithToc } from "@/lib/docMdxContent";
|
||||
import {
|
||||
OpenGraphImage,
|
||||
imageSize,
|
||||
imageContentType,
|
||||
} from "@garden-co/design-system/src/components/organisms/OpenGraphImage";
|
||||
|
||||
export const title = "Quickstart";
|
||||
export const size = imageSize;
|
||||
export const contentType = imageContentType;
|
||||
export const alt = "Jazz Docs | Quickstart";
|
||||
|
||||
export default async function Image({
|
||||
params,
|
||||
}: {
|
||||
params: Promise<{ framework: string }>;
|
||||
}) {
|
||||
const { framework } = await params;
|
||||
const { tocItems } = await getMdxWithToc(framework, []);
|
||||
|
||||
const title = tocItems[0]?.value;
|
||||
|
||||
if (!title) {
|
||||
throw new Error(`No title from tocItems in opengraph-image.tsx ${framework}`);
|
||||
}
|
||||
|
||||
return OpenGraphImage({
|
||||
title: title,
|
||||
framework,
|
||||
contents: tocItems[0]?.children?.map((child) => child.value) ?? [],
|
||||
});
|
||||
}
|
||||
@@ -6,11 +6,11 @@ import { ReactNativeLogo } from "@/components/icons/ReactNativeLogo";
|
||||
import { SvelteLogo } from "@/components/icons/SvelteLogo";
|
||||
import { VueLogo } from "@/components/icons/VueLogo";
|
||||
import { Example, features, tech } from "@/content/example";
|
||||
import { clsx } from "clsx";
|
||||
import { H2 } from "@garden-co/design-system/src/components/atoms/Headings";
|
||||
import { Icon } from "@garden-co/design-system/src/components/atoms/Icon";
|
||||
import { GappedGrid } from "@garden-co/design-system/src/components/molecules/GappedGrid";
|
||||
import { HeroHeader } from "@garden-co/design-system/src/components/molecules/HeroHeader";
|
||||
import { clsx } from "clsx";
|
||||
import type { Metadata } from "next";
|
||||
|
||||
const title = "Examples";
|
||||
@@ -198,6 +198,12 @@ const MusicIllustration = () => (
|
||||
</div>
|
||||
);
|
||||
|
||||
const JazzPaperScissorsIllustration = () => (
|
||||
<div className="flex flex-col items-center justify-center h-full p-8 text-4xl">
|
||||
✊ ✋ ✌️
|
||||
</div>
|
||||
);
|
||||
|
||||
const ImageUploadIllustration = () => (
|
||||
<div className="flex flex-col items-center justify-center h-full p-8">
|
||||
<div className="p-3 w-[12rem] h-[8rem] border border-dashed border-blue dark:border-blue-500 rounded-lg flex gap-2 flex-col items-center justify-center">
|
||||
@@ -255,21 +261,21 @@ const ReactionsIllustration = () => (
|
||||
|
||||
const MultiCursorIllustration = () => (
|
||||
<div className="flex bg-stone-100 h-full flex-col items-center justify-center dark:bg-transparent p-4">
|
||||
<div className=" bg-white md:aspect-[3/2] flex flex-col rounded-md shadow-xl shadow-stone-400/20 dark:shadow-none">
|
||||
<div className=" bg-white min-w-64 md:aspect-[3/2] flex flex-col rounded-md shadow-xl shadow-stone-400/20 dark:shadow-none">
|
||||
<div className="w-full py-2 flex items-center gap-1.5 px-2 border-b dark:border-b-stone-200">
|
||||
<span className="rounded-full size-2 bg-stone-200"></span>
|
||||
<span className="rounded-full size-2 bg-stone-200"></span>
|
||||
<span className="rounded-full size-2 bg-stone-200"></span>
|
||||
</div>
|
||||
|
||||
<div className="h-full mx-auto flex flex-col justify-center p-12 sm:p-16">
|
||||
<div className="h-full mx-auto flex flex-col justify-center p-12">
|
||||
<div className="inline-block relative px-1 ring-1 ring-blue-400">
|
||||
<div className="absolute size-2 bg-white border border-blue-400 -left-1 -top-1"></div>
|
||||
<div className="absolute size-2 bg-white border border-blue-400 -right-1 -top-1"></div>
|
||||
<div className="absolute size-2 bg-white border border-blue-400 -left-1 -bottom-1"></div>
|
||||
<div className="absolute size-2 bg-white border border-blue-400 -right-1 -bottom-1"></div>
|
||||
|
||||
<span className="text-lg font-semibold md:text-2xl md:font-bold text-stone-800 ">
|
||||
<span className="text-lg font-semibold md:text-2xl md:font-bold text-stone-800">
|
||||
Hello, world!
|
||||
</span>
|
||||
<div className="absolute -top-10 right-4 text-rose-600 flex items-end gap-1">
|
||||
@@ -285,6 +291,21 @@ const MultiCursorIllustration = () => (
|
||||
</div>
|
||||
);
|
||||
|
||||
const CoTextIllustration = () => (
|
||||
<div className="flex bg-stone-100 h-full flex-col items-center justify-center dark:bg-transparent p-4">
|
||||
<div className=" bg-white md:aspect-[3/2] min-w-64 flex flex-col rounded-md shadow-xl shadow-stone-400/20 dark:shadow-none">
|
||||
<div className="flex gap-2 p-3 border-b">
|
||||
<Icon name="bold" size="xs" />
|
||||
<Icon name="italic" size="xs" />
|
||||
<Icon name="code" size="xs" />
|
||||
</div>
|
||||
<div className="py-2 px-3 text-xl text-stone-800">
|
||||
<em>Hello</em>, <strong>world!</strong>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
|
||||
const PetIllustration = () => (
|
||||
<div className="h-full p-4 bg-[url('/dog.jpg')] bg-cover bg-center p-4 flex items-end">
|
||||
<div className="inline-flex justify-center gap-1 mx-auto">
|
||||
@@ -434,9 +455,19 @@ const reactExamples: Example[] = [
|
||||
"Track user presence on a canvas with multiple cursors and out of bounds indicators.",
|
||||
tech: [tech.react],
|
||||
features: [features.coFeed],
|
||||
demoUrl: "https://jazz-multi-cursors.vercel.app",
|
||||
demoUrl: "https://multi-cursors-demo.jazz.tools",
|
||||
illustration: <MultiCursorIllustration />,
|
||||
},
|
||||
{
|
||||
name: "Collaborative rich text",
|
||||
slug: "richtext",
|
||||
description:
|
||||
"Handle multiple users editing the same text, integrated with a ProseMirror editor for rich text.",
|
||||
tech: [tech.react],
|
||||
features: [features.coRichText, features.coPlainText],
|
||||
demoUrl: "https://richtext-demo.jazz.tools",
|
||||
illustration: <CoTextIllustration />,
|
||||
},
|
||||
{
|
||||
name: "Rate my pet",
|
||||
slug: "pets",
|
||||
@@ -477,6 +508,16 @@ const reactExamples: Example[] = [
|
||||
demoUrl: "https://music-demo.jazz.tools",
|
||||
illustration: <MusicIllustration />,
|
||||
},
|
||||
{
|
||||
name: "Jazz paper scissors",
|
||||
slug: "jazz-paper-scissors",
|
||||
description:
|
||||
"A game that shows how to communicate with other accounts through the experimental Inbox API.",
|
||||
tech: [tech.react],
|
||||
features: [features.serverWorker, features.inbox],
|
||||
illustration: <JazzPaperScissorsIllustration />,
|
||||
demoUrl: "https://jazz-paper-scissors.vercel.app",
|
||||
},
|
||||
{
|
||||
name: "Clerk",
|
||||
slug: "clerk",
|
||||
@@ -511,6 +552,7 @@ const reactExamples: Example[] = [
|
||||
tech: [tech.react],
|
||||
features: [features.inviteLink],
|
||||
illustration: <OrganizationIllustration />,
|
||||
demoUrl: "https://jazz-organization.vercel.app",
|
||||
},
|
||||
{
|
||||
name: "Version history",
|
||||
@@ -519,6 +561,7 @@ const reactExamples: Example[] = [
|
||||
"Track and restore previous versions of your data, and see who made the changes.",
|
||||
tech: [tech.react],
|
||||
illustration: <VersionHistoryIllustration />,
|
||||
demoUrl: "https://jazz-version-history.vercel.app",
|
||||
},
|
||||
];
|
||||
|
||||
@@ -566,7 +609,6 @@ const vueExamples: Example[] = [
|
||||
description: "A todo list where you can collaborate with invited guests.",
|
||||
tech: [tech.vue],
|
||||
features: [features.inviteLink],
|
||||
demoUrl: "https://todo-demo.jazz.tools",
|
||||
illustration: (
|
||||
<div className="h-full w-full bg-cover bg-[url('/todo.jpg')] bg-left-bottom"></div>
|
||||
),
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import LatencyChart from "@/components/LatencyChart";
|
||||
import { clsx } from "clsx";
|
||||
import { HeroHeader } from "@garden-co/design-system/src/components/molecules/HeroHeader";
|
||||
import { clsx } from "clsx";
|
||||
import type { Metadata } from "next";
|
||||
import { Fragment } from "react";
|
||||
|
||||
|
||||
@@ -53,6 +53,7 @@ pre.shiki .line {
|
||||
.twoslash-popup-code pre.shiki .line {
|
||||
display: inline;
|
||||
padding-left: 0;
|
||||
white-space: break-spaces;
|
||||
}
|
||||
|
||||
html.dark .shiki {
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
import "./globals.css";
|
||||
import type { Metadata } from "next";
|
||||
import { fontClasses } from "@garden-co/design-system/src/fonts";
|
||||
import { ThemeProvider } from "@/components/ThemeProvider";
|
||||
import { JazzFooter } from "@/components/footer";
|
||||
import { marketingCopy } from "@/content/marketingCopy";
|
||||
import { fontClasses } from "@garden-co/design-system/src/fonts";
|
||||
import { Analytics } from "@vercel/analytics/react";
|
||||
import { SpeedInsights } from "@vercel/speed-insights/next";
|
||||
import type { Metadata } from "next";
|
||||
|
||||
const metaTags = {
|
||||
title: `Jazz - ${marketingCopy.headline}`,
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
import { marketingCopy } from "@/content/marketingCopy";
|
||||
import OpenGraphImage, {
|
||||
import {
|
||||
OpenGraphImage,
|
||||
imageSize,
|
||||
imageContentType,
|
||||
} from "@garden-co/design-system/src/components/organisms/OpenGraphImage";
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
"use client";
|
||||
|
||||
import { track } from "@vercel/analytics";
|
||||
import { Button } from "@garden-co/design-system/src/components/atoms/Button";
|
||||
import { track } from "@vercel/analytics";
|
||||
|
||||
export function FakeGetStartedButton({ tier }: { tier: "starter" | "indie" }) {
|
||||
return (
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import { clsx } from "clsx";
|
||||
import { Button } from "@garden-co/design-system/src/components/atoms/Button";
|
||||
import { clsx } from "clsx";
|
||||
import {
|
||||
CircleCheckIcon,
|
||||
LucideBuilding2,
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
"use client";
|
||||
|
||||
import { clsx } from "clsx";
|
||||
import { Icon } from "@garden-co/design-system/src/components/atoms/Icon";
|
||||
import { clsx } from "clsx";
|
||||
import Link from "next/link";
|
||||
import { usePathname } from "next/navigation";
|
||||
import { ReactNode } from "react";
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { JazzNav } from "@/components/nav";
|
||||
import { clsx } from "clsx";
|
||||
import { NavSection } from "@garden-co/design-system/src/components/organisms/Nav";
|
||||
import { clsx } from "clsx";
|
||||
|
||||
export function SideNavLayout({
|
||||
children,
|
||||
|
||||
@@ -2,9 +2,9 @@
|
||||
|
||||
import { TableOfContents } from "@/components/docs/TableOfContents";
|
||||
import { JazzMobileNav } from "@/components/nav";
|
||||
import { TocEntry } from "@stefanprobst/rehype-extract-toc";
|
||||
import type { IconName } from "@garden-co/design-system/src/components/atoms/Icon";
|
||||
import { NavSection } from "@garden-co/design-system/src/components/organisms/Nav";
|
||||
import { TocEntry } from "@stefanprobst/rehype-extract-toc";
|
||||
|
||||
export default function DocsLayout({
|
||||
children,
|
||||
@@ -19,8 +19,7 @@ export default function DocsLayout({
|
||||
navIcon?: IconName;
|
||||
tocItems?: TocEntry[];
|
||||
}) {
|
||||
const tableOfContentsItems =
|
||||
tocItems?.length && tocItems[0].children ? tocItems[0].children : [];
|
||||
const tableOfContentsItems = tocItems ?? [];
|
||||
|
||||
const navSections: NavSection[] = [
|
||||
{
|
||||
|
||||
@@ -3,13 +3,14 @@
|
||||
import type { Toc, TocEntry } from "@stefanprobst/rehype-extract-toc";
|
||||
import { clsx } from "clsx";
|
||||
import Link from "next/link";
|
||||
import { useCallback, useEffect, useState } from "react";
|
||||
import { useCallback, useEffect, useMemo, useState } from "react";
|
||||
|
||||
const TocList = ({
|
||||
items,
|
||||
level,
|
||||
currentId,
|
||||
}: { items: Toc; level: number; currentId: string }) => {
|
||||
|
||||
const isActive = (item: TocEntry) => {
|
||||
if (!item.id) return false;
|
||||
if (item.id === currentId) return true;
|
||||
@@ -20,7 +21,7 @@ const TocList = ({
|
||||
};
|
||||
|
||||
return (
|
||||
<ul className="space-y-2" style={{ paddingLeft: level ? "1rem" : "0" }}>
|
||||
<ul className="space-y-2" style={{ paddingLeft: (level > 0) ? "1rem" : "0" }}>
|
||||
{items.map((item) => (
|
||||
<li key={item.id} className="space-y-2">
|
||||
{item.id && (
|
||||
@@ -57,8 +58,10 @@ export function TableOfContents({
|
||||
}) {
|
||||
const [currentId, setCurrentId] = useState<string>("");
|
||||
|
||||
const itemsUnderH1 = useMemo(() => items[0]?.children || [], [items]);
|
||||
|
||||
const getHeadings = useCallback(() => {
|
||||
return items
|
||||
return itemsUnderH1
|
||||
.flatMap((node) => {
|
||||
const headings = [node];
|
||||
if (node.children) {
|
||||
@@ -78,17 +81,17 @@ export function TableOfContents({
|
||||
return { id: item.id, top };
|
||||
})
|
||||
.filter((x): x is { id: string; top: number } => x !== null);
|
||||
}, [items]);
|
||||
}, [itemsUnderH1]);
|
||||
|
||||
useEffect(() => {
|
||||
if (items.length === 0) return;
|
||||
if (itemsUnderH1.length === 0) return;
|
||||
|
||||
const onScroll = () => {
|
||||
const headings = getHeadings();
|
||||
if (headings.length === 0) return;
|
||||
|
||||
const top = window.scrollY;
|
||||
let current = headings[0].id;
|
||||
let current = headings[0]?.id;
|
||||
|
||||
for (const heading of headings) {
|
||||
if (top >= heading.top - 500) {
|
||||
@@ -98,7 +101,7 @@ export function TableOfContents({
|
||||
}
|
||||
}
|
||||
|
||||
setCurrentId(current);
|
||||
current && setCurrentId(current);
|
||||
};
|
||||
|
||||
window.addEventListener("scroll", onScroll, { passive: true });
|
||||
@@ -107,14 +110,14 @@ export function TableOfContents({
|
||||
return () => {
|
||||
window.removeEventListener("scroll", onScroll);
|
||||
};
|
||||
}, [getHeadings, items]);
|
||||
}, [getHeadings, itemsUnderH1]);
|
||||
|
||||
if (!items.length) return null;
|
||||
if (!itemsUnderH1.length) return null;
|
||||
|
||||
return (
|
||||
<div className={className}>
|
||||
<p className="font-medium text-highlight mb-3">On this page</p>
|
||||
<TocList items={items} level={0} currentId={currentId} />
|
||||
<TocList items={itemsUnderH1} level={0} currentId={currentId} />
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
|
||||
import { Example } from "@/content/example";
|
||||
import { InterpolateInCode } from "@/mdx-components";
|
||||
import { DialogDescription } from "@headlessui/react";
|
||||
import { Button } from "@garden-co/design-system/src/components/atoms/Button";
|
||||
import { CodeGroup } from "@garden-co/design-system/src/components/molecules/CodeGroup";
|
||||
import {
|
||||
@@ -11,6 +10,7 @@ import {
|
||||
DialogBody,
|
||||
DialogTitle,
|
||||
} from "@garden-co/design-system/src/components/organisms/Dialog";
|
||||
import { DialogDescription } from "@headlessui/react";
|
||||
import { useState } from "react";
|
||||
import CreateJazzApp from "./CreateJazzApp.mdx";
|
||||
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
```tsx
|
||||
<JazzProvider
|
||||
sync={{ peer: "wss://cloud.jazz.tools/?key=you@example.com" }}
|
||||
sync={{
|
||||
peer: "wss://cloud.jazz.tools/?key=you@example.com"
|
||||
}}
|
||||
>
|
||||
{children}
|
||||
</JazzProvider>
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
import { clsx } from "clsx";
|
||||
import { Card } from "@garden-co/design-system/src/components/atoms/Card";
|
||||
import { H2 } from "@garden-co/design-system/src/components/atoms/Headings";
|
||||
import { Kicker } from "@garden-co/design-system/src/components/atoms/Kicker";
|
||||
import { GappedGrid } from "@garden-co/design-system/src/components/molecules/GappedGrid";
|
||||
import { clsx } from "clsx";
|
||||
import CodeStepAction from "./CodeStepAction.mdx";
|
||||
import CodeStepCloud from "./CodeStepCloud.mdx";
|
||||
import CodeStepRender from "./CodeStepRender.mdx";
|
||||
@@ -21,7 +21,7 @@ function Code({
|
||||
<div
|
||||
className={clsx(
|
||||
className,
|
||||
"w-full h-full relative -right-2 -bottom-1 max-w-full lg:max-w-[480px] overflow-x-auto ml-auto overflow-hidden",
|
||||
"w-full h-full relative -right-2 -bottom-1 max-w-full lg:max-w-[500px] ml-auto",
|
||||
"shadow-xl shadow-blue/20",
|
||||
"rounded-tl-lg border",
|
||||
"flex-1 bg-white ring ring-4 ring-stone-400/20",
|
||||
@@ -33,7 +33,9 @@ function Code({
|
||||
{fileName}
|
||||
</span>
|
||||
</div>
|
||||
<pre className="text-xs lg:text-sm p-1 pb-2">{children}</pre>
|
||||
<pre className="text-xs lg:text-sm p-1 pb-2 overflow-x-auto">
|
||||
{children}
|
||||
</pre>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -134,9 +134,20 @@ export async function onAnonymousAccountDiscarded(
|
||||
|
||||
To see how this works, try uploading a song in the [music player demo](https://music-demo.jazz.tools/) and then log in with an existing account.
|
||||
|
||||
## Provider Configuration for Authentication
|
||||
|
||||
You can configure how authentication states work in your app with the [JazzProvider](/docs/project-setup/providers/). The provider offers several options that impact authentication behavior:
|
||||
|
||||
- `guestMode`: Enable/disable Guest Mode
|
||||
- `onAnonymousAccountDiscarded`: Handle data migration when switching accounts
|
||||
- `sync.when`: Control when data synchronization happens
|
||||
- `defaultProfileName`: Set default name for new user profiles
|
||||
|
||||
For detailed information on all provider options, see [Provider Configuration options](/docs/project-setup/providers/#additional-options).
|
||||
|
||||
## Controlling sync for different authentication states
|
||||
|
||||
You can control network sync with [Providers](/docs/project-setup/providers) based on authentication state:
|
||||
You can control network sync with [Providers](/docs/project-setup/providers/) based on authentication state:
|
||||
|
||||
- `when: "always"`: Sync is enabled for both Anonymous Authentication and Authenticated Account
|
||||
- `when: "signedUp"`: Sync is enabled when the user is authenticated
|
||||
@@ -197,7 +208,7 @@ function App() {
|
||||
|
||||
### Configuring Guest Mode Access
|
||||
|
||||
You can configure Guest Mode access with the `guestMode` prop for [Providers](/docs/project-setup/providers).
|
||||
You can configure Guest Mode access with the `guestMode` prop for [Providers](/docs/project-setup/providers/).
|
||||
|
||||
<ContentByFramework framework="react">
|
||||
<CodeGroup>
|
||||
|
||||
@@ -53,6 +53,7 @@ export const docNavigationItems = [
|
||||
name: "Providers",
|
||||
href: "/docs/project-setup/providers",
|
||||
done: {
|
||||
react: 100,
|
||||
"react-native": 100,
|
||||
"react-native-expo": 100,
|
||||
},
|
||||
@@ -168,6 +169,11 @@ export const docNavigationItems = [
|
||||
href: "/docs/using-covalues/cofeeds",
|
||||
done: 100,
|
||||
},
|
||||
{
|
||||
name: "CoTexts",
|
||||
href: "/docs/using-covalues/cotexts",
|
||||
done: 100,
|
||||
},
|
||||
{
|
||||
name: "FileStreams",
|
||||
href: "/docs/using-covalues/filestreams",
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { CodeGroup } from '@/components/forMdx'
|
||||
import { CodeGroup, ContentByFramework } from '@/components/forMdx'
|
||||
import { JazzIcon } from "@garden-co/design-system/src/components/atoms/logos/JazzIcon";
|
||||
|
||||
# Jazz Inspector
|
||||
@@ -9,11 +9,14 @@ For now, you can get your account credentials from the `jazz-logged-in-secret` l
|
||||
|
||||
[https://inspector.jazz.tools](https://inspector.jazz.tools)
|
||||
|
||||
## Exporting current account to Inspector from your app
|
||||
<ContentByFramework framework={["react", "svelte", "vue", "vanilla"]}>
|
||||
## Exporting current account to Inspector from your app [!framework=react,svelte,vue,vanilla]
|
||||
|
||||
In development mode, you can launch the Inspector from your Jazz app to inspect your account by pressing `Cmd+J`.
|
||||
</ContentByFramework>
|
||||
|
||||
## Embedding the Inspector widget into your app
|
||||
<ContentByFramework framework="react">
|
||||
## Embedding the Inspector widget into your app [!framework=react]
|
||||
|
||||
Alternatively, you can embed the Inspector directly into your app, so you don't need to open a separate window.
|
||||
|
||||
@@ -40,7 +43,7 @@ import { JazzInspector } from "jazz-inspector";
|
||||
|
||||
This will show the Inspector launch button on the right of your page.
|
||||
|
||||
### Positioning the Inspector button
|
||||
### Positioning the Inspector button [!framework=react]
|
||||
|
||||
You can also customize the button position with the following options:
|
||||
|
||||
@@ -67,3 +70,4 @@ For example:
|
||||
</div>
|
||||
|
||||
Check out the [music player app](https://github.com/garden-co/jazz/blob/main/examples/music-player/src/2_main.tsx) for a full example.
|
||||
</ContentByFramework>
|
||||
|
||||
@@ -4,8 +4,6 @@ import { CodeGroup } from "@/components/forMdx";
|
||||
|
||||
# Providers
|
||||
|
||||
## Introduction
|
||||
|
||||
`<JazzProvider />` is the core component that connects your Expo application to Jazz. It handles:
|
||||
|
||||
- **Data Synchronization**: Manages connections to peers and the Jazz cloud
|
||||
|
||||
@@ -4,8 +4,6 @@ import { CodeGroup } from "@/components/forMdx";
|
||||
|
||||
# Providers
|
||||
|
||||
## Introduction
|
||||
|
||||
`<JazzProvider />` is the core component that connects your React Native application to Jazz. It handles:
|
||||
|
||||
- **Data Synchronization**: Manages connections to peers and the Jazz cloud
|
||||
|
||||
193
homepage/homepage/content/docs/project-setup/providers/react.mdx
Normal file
193
homepage/homepage/content/docs/project-setup/providers/react.mdx
Normal file
@@ -0,0 +1,193 @@
|
||||
export const metadata = { title: "Providers" };
|
||||
|
||||
import { CodeGroup } from "@/components/forMdx";
|
||||
|
||||
# Providers
|
||||
|
||||
`<JazzProvider />` is the core component that connects your React application to Jazz. It handles:
|
||||
|
||||
- **Data Synchronization**: Manages connections to peers and the Jazz cloud
|
||||
- **Local Storage**: Persists data locally between app sessions
|
||||
- **Schema Types**: Provides APIs for the [AccountSchema](/docs/schemas/accounts-and-migrations)
|
||||
- **Authentication**: Connects your authentication system to Jazz
|
||||
|
||||
Our [Chat example app](https://jazz.tools/examples#chat) provides a complete implementation of JazzProvider with authentication and real-time data sync.
|
||||
|
||||
## Setting up the Provider
|
||||
|
||||
The `<JazzProvider />` accepts several configuration options:
|
||||
|
||||
<CodeGroup>
|
||||
```tsx twoslash
|
||||
// @filename: schema.ts
|
||||
import { Account, co } from "jazz-tools";
|
||||
|
||||
export class MyAppAccount extends Account {
|
||||
name = co.string;
|
||||
}
|
||||
|
||||
// @filename: app.tsx
|
||||
import * as React from "react";
|
||||
// ---cut---
|
||||
// App.tsx
|
||||
import { JazzProvider } from "jazz-react";
|
||||
import { MyAppAccount } from "./schema";
|
||||
|
||||
export function MyApp({ children }: { children: React.ReactNode }) {
|
||||
return (
|
||||
<JazzProvider
|
||||
sync={{
|
||||
peer: "wss://cloud.jazz.tools/?key=your-api-key",
|
||||
when: "always" // When to sync: "always", "never", or "signedUp"
|
||||
}}
|
||||
AccountSchema={MyAppAccount}
|
||||
>
|
||||
{children}
|
||||
</JazzProvider>
|
||||
);
|
||||
}
|
||||
|
||||
// Register the Account schema so `useAccount` returns our custom `MyAppAccount`
|
||||
declare module "jazz-react" {
|
||||
interface Register {
|
||||
Account: MyAppAccount;
|
||||
}
|
||||
}
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
## Provider Options
|
||||
|
||||
### Sync Options
|
||||
|
||||
The `sync` property configures how your application connects to the Jazz network:
|
||||
|
||||
<CodeGroup>
|
||||
```tsx twoslash
|
||||
import { type SyncConfig } from "jazz-tools";
|
||||
|
||||
const syncConfig: SyncConfig = {
|
||||
// Connection to Jazz Cloud or your own sync server
|
||||
peer: "wss://cloud.jazz.tools/?key=your-api-key",
|
||||
|
||||
// When to sync: "always" (default), "never", or "signedUp"
|
||||
when: "always",
|
||||
}
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
See [Authentication States](/docs/authentication/authentication-states#controlling-sync-for-different-authentication-states) for more details on how the `when` property affects synchronization based on authentication state.
|
||||
|
||||
### Account Schema
|
||||
|
||||
The `AccountSchema` property defines your application's account structure:
|
||||
|
||||
<CodeGroup>
|
||||
```tsx twoslash
|
||||
|
||||
// @filename: schema.ts
|
||||
import { Account, CoMap, co } from "jazz-tools";
|
||||
// schema.ts
|
||||
class Preferences extends CoMap {
|
||||
theme = co.string;
|
||||
notifications = co.boolean;
|
||||
}
|
||||
|
||||
// Define your custom account schema
|
||||
export class MyAppAccount extends Account {
|
||||
name = co.string;
|
||||
preferences = co.ref(Preferences);
|
||||
}
|
||||
|
||||
// @filename: app.tsx
|
||||
import * as React from "react";
|
||||
import { JazzProvider } from "jazz-react";
|
||||
import { SyncConfig } from "jazz-tools";
|
||||
|
||||
const syncConfig: SyncConfig = {
|
||||
peer: "wss://cloud.jazz.tools/?key=your-api-key",
|
||||
when: "always",
|
||||
}
|
||||
|
||||
// ---cut---
|
||||
// app.tsx
|
||||
import { MyAppAccount } from "./schema";
|
||||
|
||||
export function MyApp ({ children }: { children: React.ReactNode }) {
|
||||
// Use in provider
|
||||
return (
|
||||
<JazzProvider
|
||||
sync={syncConfig}
|
||||
|
||||
AccountSchema={MyAppAccount}
|
||||
>
|
||||
{children}
|
||||
</JazzProvider>
|
||||
);
|
||||
}
|
||||
|
||||
// Register type for useAccount
|
||||
declare module "jazz-react" {
|
||||
interface Register {
|
||||
Account: MyAppAccount;
|
||||
}
|
||||
}
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
### Additional Options
|
||||
|
||||
The provider accepts these additional options:
|
||||
|
||||
<CodeGroup>
|
||||
```tsx twoslash
|
||||
import * as React from "react";
|
||||
import { JazzProvider } from "jazz-react";
|
||||
import { SyncConfig } from "jazz-tools";
|
||||
|
||||
const syncConfig: SyncConfig = {
|
||||
peer: "wss://cloud.jazz.tools/?key=your-api-key",
|
||||
when: "always",
|
||||
}
|
||||
|
||||
// ---cut---
|
||||
// app.tsx
|
||||
export function MyApp ({ children }: { children: React.ReactNode }) {
|
||||
return (
|
||||
<JazzProvider
|
||||
sync={syncConfig}
|
||||
|
||||
// Enable guest mode for account-less access
|
||||
guestMode={false}
|
||||
|
||||
// Set default name for new user profiles
|
||||
defaultProfileName="New User"
|
||||
|
||||
// Handle user logout
|
||||
onLogOut={() => {
|
||||
console.log("User logged out");
|
||||
}}
|
||||
|
||||
// Handle anonymous account data when user logs in to existing account
|
||||
onAnonymousAccountDiscarded={(account) => {
|
||||
console.log("Anonymous account discarded", account.id);
|
||||
// Migrate data here
|
||||
return Promise.resolve();
|
||||
}}
|
||||
>
|
||||
{children}
|
||||
</JazzProvider>
|
||||
);
|
||||
}
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
See [Authentication States](/docs/authentication/authentication-states) for more information on authentication states, guest mode, and handling anonymous accounts.
|
||||
|
||||
## Authentication
|
||||
|
||||
`<JazzProvider />` works with various authentication methods to enable users to access their data across multiple devices. For a complete guide to authentication, see our [Authentication Overview](/docs/authentication/overview).
|
||||
|
||||
## Need Help?
|
||||
|
||||
If you have questions about configuring the Jazz Provider for your specific use case, [join our Discord community](https://discord.gg/utDMjHYg42) for help.
|
||||
@@ -1,99 +1,380 @@
|
||||
export const metadata = { title: "React" };
|
||||
export const metadata = { title: "Installation" };
|
||||
|
||||
import { CodeGroup } from "@/components/forMdx";
|
||||
|
||||
# <span id="react">React</span>
|
||||
# Installation and Setup
|
||||
|
||||
Wrap your application with `<JazzProvider />`, this is where you specify the sync & storage server to connect to (see [Sync and storage](/docs/react/sync-and-storage)).
|
||||
Add Jazz to your React application in minutes. This setup covers standard React apps, Next.js, and gives an overview of experimental SSR approaches.
|
||||
|
||||
Integrating Jazz with React is straightforward. You'll define data schemas that describe your application's structure, then wrap your app with a provider that handles sync and storage. The whole process takes just three steps:
|
||||
|
||||
1. [Install dependencies](#install-dependencies)
|
||||
2. [Write your schema](#write-your-schema)
|
||||
3. [Wrap your app in `<JazzProvider />`](#standard-react-setup)
|
||||
|
||||
Looking for complete examples? Check out our [example applications](/examples) for chat apps, collaborative editors, and more.
|
||||
|
||||
## Install dependencies
|
||||
|
||||
First, install the required packages:
|
||||
|
||||
<CodeGroup>
|
||||
{/* prettier-ignore */}
|
||||
```tsx
|
||||
```bash
|
||||
pnpm install jazz-react jazz-tools
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
## Write your schema
|
||||
|
||||
Define your data schema using [CoValues](/docs/schemas/covalues) from `jazz-tools`.
|
||||
|
||||
<CodeGroup>
|
||||
```tsx twoslash
|
||||
// schema.ts
|
||||
import { Account, co } from "jazz-tools";
|
||||
|
||||
export class MyAppAccount extends Account {
|
||||
name = co.string;
|
||||
}
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
See [CoValues](/docs/schemas/covalues) for more information on how to define your schema.
|
||||
|
||||
## Standard React Setup
|
||||
|
||||
Wrap your application with `<JazzProvider />` to connect to the Jazz network and define your data schema:
|
||||
|
||||
<CodeGroup>
|
||||
```tsx twoslash
|
||||
// @filename: schema.ts
|
||||
import { Account } from "jazz-tools";
|
||||
|
||||
export class MyAppAccount extends Account {}
|
||||
// @filename: app.tsx
|
||||
import * as React from "react";
|
||||
import { createRoot } from 'react-dom/client';
|
||||
|
||||
function App() {
|
||||
return <div>Hello, world!</div>;
|
||||
}
|
||||
// ---cut---
|
||||
// app.tsx
|
||||
import { JazzProvider } from "jazz-react";
|
||||
import { MyAppAccount } from "./schema";
|
||||
|
||||
ReactDOM.createRoot(document.getElementById("root")!).render(
|
||||
<JazzProvider // [!code ++:6]
|
||||
sync={{ peer: "wss://cloud.jazz.tools/?key=you@example.com" }}
|
||||
AccountSchema={MyAppAccount}
|
||||
>
|
||||
<App />
|
||||
</JazzProvider>
|
||||
createRoot(document.getElementById("root")!).render(
|
||||
<JazzProvider
|
||||
sync={{ peer: "wss://cloud.jazz.tools/?key=you@example.com" }}
|
||||
AccountSchema={MyAppAccount}
|
||||
>
|
||||
<App />
|
||||
</JazzProvider>
|
||||
);
|
||||
|
||||
// [!code ++:6]
|
||||
// Register the Account schema so `useAccount` returns our custom `MyAppAccount`
|
||||
// Register your Account schema to enhance TypeScript support
|
||||
declare module "jazz-react" {
|
||||
interface Register {
|
||||
Account: MyAppAccount;
|
||||
}
|
||||
interface Register {
|
||||
Account: MyAppAccount;
|
||||
}
|
||||
}
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
This setup handles:
|
||||
- Connection to the Jazz sync server
|
||||
- Schema registration for type-safe data handling
|
||||
- Local storage configuration
|
||||
|
||||
With this in place, you're ready to start using Jazz hooks in your components. [Learn how to access and update your data](/docs/using-covalues/subscription-and-loading#subscription-hooks).
|
||||
|
||||
## Next.js
|
||||
## Next.js Integration
|
||||
|
||||
### Client-side only
|
||||
### Client-side Only (Easiest)
|
||||
|
||||
The easiest way to use Jazz with Next.JS is to only use it on the client side. You can ensure this by:
|
||||
|
||||
- marking the Jazz provider file as `"use client"`
|
||||
The simplest approach for Next.js is client-side only integration:
|
||||
|
||||
<CodeGroup>
|
||||
{/* prettier-ignore */}
|
||||
```tsx
|
||||
"use client" // [!code ++]
|
||||
```tsx twoslash
|
||||
// @filename: schema.ts
|
||||
import { Account } from "jazz-tools";
|
||||
|
||||
export class MyAppAccount extends Account {}
|
||||
// @filename: app.tsx
|
||||
import * as React from "react";
|
||||
// ---cut---
|
||||
// app.tsx
|
||||
"use client" // Mark as client component
|
||||
|
||||
import { JazzProvider } from "jazz-react";
|
||||
import { MyAppAccount } from "./schema";
|
||||
|
||||
export function MyJazzProvider(props: { children: React.ReactNode }) {
|
||||
return (
|
||||
<JazzProvider
|
||||
sync={{ peer: "wss://cloud.jazz.tools/?key=you@example.com" }}
|
||||
AccountSchema={MyAppAccount}
|
||||
>
|
||||
{props.children}
|
||||
</JazzProvider>
|
||||
);
|
||||
export function JazzWrapper({ children }: { children: React.ReactNode }) {
|
||||
return (
|
||||
<JazzProvider
|
||||
sync={{ peer: "wss://cloud.jazz.tools/?key=you@example.com" }}
|
||||
AccountSchema={MyAppAccount}
|
||||
>
|
||||
{children}
|
||||
</JazzProvider>
|
||||
);
|
||||
}
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
- marking any file with components where you use Jazz hooks (such as `useAccount` or `useCoState`) as `"use client"`
|
||||
Remember to mark any component that uses Jazz hooks with `"use client"`:
|
||||
|
||||
### SSR use (experimental)
|
||||
<CodeGroup>
|
||||
```tsx twoslash
|
||||
// @filename: schema.ts
|
||||
import { Account, co } from "jazz-tools";
|
||||
|
||||
Pure SSR use of Jazz is basically just using jazz-nodejs (see [Node.JS / Server Workers](/docs/react/project-setup/server-side)) inside Server Components.
|
||||
export class MyAppAccount extends Account {
|
||||
name = co.string;
|
||||
}
|
||||
// @filename: Profile.tsx
|
||||
import * as React from "react";
|
||||
import { MyAppAccount } from "./schema";
|
||||
|
||||
Instead of using hooks as you would on the client, you await promises returned by `CoValue.load(...)` inside your Server Components.
|
||||
declare module "jazz-react" {
|
||||
interface Register {
|
||||
Account: MyAppAccount;
|
||||
}
|
||||
}
|
||||
// ---cut---
|
||||
// Profile.tsx
|
||||
"use client"; // [!code ++]
|
||||
|
||||
TODO: code example
|
||||
import { useAccount } from "jazz-react";
|
||||
|
||||
This should work well for cases like rendering publicly-readable information, since the worker account will be able to load them.
|
||||
export function Profile() {
|
||||
const { me } = useAccount();
|
||||
|
||||
return <div>Hello, {me?.name}</div>;
|
||||
}
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
In the future, it will be possible to use trusted auth methods (such as Clerk, Auth0, etc.) that let you act as the same Jazz user both on the client and on the server, letting you use SSR even for data private to that user.
|
||||
### SSR Support (Experimental)
|
||||
|
||||
### SSR + client-side (experimental)
|
||||
For server-side rendering, Jazz offers experimental approaches:
|
||||
|
||||
You can combine the two approaches by creating
|
||||
- Pure SSR
|
||||
- Hybrid SSR + Client Hydration
|
||||
|
||||
1. A pure "rendering" component that renders an already-loaded CoValue (in JSON-ified form)
|
||||
#### Pure SSR
|
||||
|
||||
TODO: code example
|
||||
Use Jazz in server components by directly loading data with `CoValue.load()`.
|
||||
|
||||
2. A "hydrating" component (with `"use client"`) that
|
||||
{/*
|
||||
<CodeGroup>
|
||||
```tsx twoslash
|
||||
// @errors: 18047
|
||||
// @filename: schema.ts
|
||||
import { co, CoList, CoMap } from "jazz-tools";
|
||||
|
||||
- expects a pre-loaded CoValue as a prop (in JSON-ified form)
|
||||
- uses one of the client-side Jazz hooks (such as `useAccount` or `useCoState`) to subscribe to that same CoValue
|
||||
- passing the client-side subscribed state to the "rendering" component, with the pre-loaded CoValue as a fallback until the client receives the first subscribed state
|
||||
export class MyItem extends CoMap {
|
||||
title = co.string;
|
||||
}
|
||||
|
||||
TODO: code example
|
||||
export class MyCollection extends CoList.Of(co.ref(MyItem)) {}
|
||||
// @filename: PublicData.tsx
|
||||
import * as React from "react";
|
||||
import { ID } from "jazz-tools";
|
||||
const collectionID = "co_z123" as ID<MyCollection>;
|
||||
// ---cut---
|
||||
// Server Component (no "use client" directive)
|
||||
import { MyCollection, MyItem } from "./schema";
|
||||
|
||||
3. A "pre-loading" Server Component that
|
||||
export default async function PublicData() {
|
||||
// Load data directly in the server component
|
||||
const items = await MyCollection.load(collectionID);
|
||||
|
||||
if (!items) {
|
||||
return <div>Loading...</div>;
|
||||
}
|
||||
|
||||
return (
|
||||
<ul>
|
||||
{items.map(item => (
|
||||
item ? <li key={item.id}>{item.title}</li> : null
|
||||
))}
|
||||
</ul>
|
||||
);
|
||||
}
|
||||
```
|
||||
</CodeGroup>
|
||||
*/}
|
||||
|
||||
- pre-loads the CoValue by awaiting it's `load(...)` method (as described above)
|
||||
- renders the "hydrating" component, passing the pre-loaded CoValue as a prop
|
||||
This works well for public data accessible to the server account.
|
||||
|
||||
TODO: code example
|
||||
#### Hybrid SSR + Client Hydration
|
||||
|
||||
For more complex cases, you can pre-render on the server and hydrate on the client:
|
||||
|
||||
1. Create a shared rendering component.
|
||||
|
||||
{/*
|
||||
<CodeGroup>
|
||||
```tsx twoslash
|
||||
// @filename: schema.ts
|
||||
import { co, CoList, CoMap } from "jazz-tools";
|
||||
|
||||
export class MyItem extends CoMap {
|
||||
title = co.string;
|
||||
}
|
||||
// @filename: ItemList.tsx
|
||||
import * as React from "react";
|
||||
import { MyItem } from "./schema";
|
||||
// ---cut---
|
||||
// ItemList.tsx - works in both server and client contexts
|
||||
export function ItemList({ items }: { items: MyItem[] }) {
|
||||
return (
|
||||
<ul>
|
||||
{items.map(item => (
|
||||
<li key={item.id}>{item.title}</li>
|
||||
))}
|
||||
</ul>
|
||||
);
|
||||
}
|
||||
```
|
||||
</CodeGroup>
|
||||
*/}
|
||||
|
||||
2. Create a client hydration component.
|
||||
|
||||
{/*
|
||||
<CodeGroup>
|
||||
```tsx twoslash
|
||||
// @filename: schema.ts
|
||||
import { co, CoList, CoMap } from "jazz-tools";
|
||||
|
||||
export class MyItem extends CoMap {
|
||||
title = co.string;
|
||||
}
|
||||
export class MyCollection extends CoList.Of(co.ref(MyItem)) {}
|
||||
// @filename: ItemList.tsx
|
||||
import * as React from "react";
|
||||
import { MyItem } from "./schema";
|
||||
|
||||
export function ItemList({ items }: { items: MyItem[] }) {
|
||||
return (
|
||||
<ul>
|
||||
{items.map(item => (
|
||||
<li key={item.id}>{item.title}</li>
|
||||
))}
|
||||
</ul>
|
||||
);
|
||||
}
|
||||
// @filename: ItemListHydrator.tsx
|
||||
// ItemListHydrator.tsx
|
||||
import * as React from "react";
|
||||
import { useCoState } from "jazz-react";
|
||||
import { ID } from "jazz-tools";
|
||||
const myCollectionID = "co_z123" as ID<MyCollection>;
|
||||
// ---cut---
|
||||
"use client"
|
||||
|
||||
import { MyCollection, MyItem } from "./schema";
|
||||
import { ItemList } from "./ItemList";
|
||||
export function ItemListHydrator({ initialItems }: { initialItems: MyItem[] }) {
|
||||
// Hydrate with real-time data once client loads
|
||||
const myCollection = useCoState(MyCollection, myCollectionID);
|
||||
|
||||
// Filter out nulls for type safety
|
||||
const items = Array.from(myCollection?.values() || []).filter(
|
||||
(item): item is MyItem => !!item
|
||||
);
|
||||
|
||||
// Use server data until client data is available
|
||||
const displayItems = items || initialItems;
|
||||
|
||||
return <ItemList items={displayItems} />;
|
||||
}
|
||||
```
|
||||
</CodeGroup>
|
||||
*/}
|
||||
|
||||
3. Create a server component that pre-loads data.
|
||||
|
||||
{/*
|
||||
<CodeGroup>
|
||||
```tsx twoslash
|
||||
// @filename: schema.ts
|
||||
import { co, CoList, CoMap } from "jazz-tools";
|
||||
|
||||
export class MyItem extends CoMap {
|
||||
title = co.string;
|
||||
}
|
||||
|
||||
export class MyCollection extends CoList.Of(co.ref(MyItem)) {}
|
||||
// @filename: ItemList.tsx
|
||||
import * as React from "react";
|
||||
import { MyItem } from "./schema";
|
||||
|
||||
export function ItemList({ items }: { items: MyItem[] }) {
|
||||
return (
|
||||
<ul>
|
||||
{items.map(item => (
|
||||
<li key={item.id}>{item.title}</li>
|
||||
))}
|
||||
</ul>
|
||||
);
|
||||
}
|
||||
// @filename: ItemListHydrator.tsx
|
||||
// ItemListHydrator.tsx
|
||||
import * as React from "react";
|
||||
import { useCoState } from "jazz-react";
|
||||
import { ID } from "jazz-tools";
|
||||
const myCollectionID = "co_z123" as ID<MyCollection>;
|
||||
// ---cut---
|
||||
"use client"
|
||||
|
||||
import { MyCollection, MyItem } from "./schema";
|
||||
import { ItemList } from "./ItemList";
|
||||
export function ItemListHydrator({ initialItems }: { initialItems: MyItem[] }) {
|
||||
// Hydrate with real-time data once client loads
|
||||
const myCollection = useCoState(MyCollection, myCollectionID);
|
||||
|
||||
// Filter out nulls for type safety
|
||||
const items = Array.from(myCollection?.values() || []).filter(
|
||||
(item): item is MyItem => !!item
|
||||
);
|
||||
|
||||
// Use server data until client data is available
|
||||
const displayItems = items || initialItems;
|
||||
|
||||
return <ItemList items={displayItems} />;
|
||||
}
|
||||
// @filename: ServerItemPage.tsx
|
||||
import * as React from 'react';
|
||||
import { ID } from "jazz-tools";
|
||||
import { MyCollection, MyItem } from "./schema";
|
||||
import { ItemListHydrator } from "./ItemListHydrator";
|
||||
const myCollectionID = "co_z123" as ID<MyCollection>;
|
||||
// ---cut---
|
||||
// ServerItemPage.tsx
|
||||
export default async function ServerItemPage() {
|
||||
// Pre-load data on the server
|
||||
const initialItems = await MyCollection.load(myCollectionID);
|
||||
|
||||
// Filter out nulls for type safety
|
||||
const items = Array.from(initialItems?.values() || []).filter(
|
||||
(item): item is MyItem => !!item
|
||||
);
|
||||
|
||||
// Pass to client hydrator
|
||||
return <ItemListHydrator initialItems={items} />;
|
||||
}
|
||||
```
|
||||
</CodeGroup>
|
||||
*/}
|
||||
|
||||
This approach gives you the best of both worlds: fast initial loading with server rendering, plus real-time updates on the client.
|
||||
|
||||
## Further Reading
|
||||
|
||||
- [Schemas](/docs/schemas/covalues) - Learn about defining your data model
|
||||
- [Provider Configuration](/docs/project-setup/providers) - Learn about other configuration options for Providers
|
||||
- [Authentication](/docs/authentication/overview) - Set up user authentication
|
||||
- [Sync and Storage](/docs/sync-and-storage) - Learn about data persistence
|
||||
|
||||
@@ -12,7 +12,7 @@ As their name suggests, CoValues are inherently collaborative, meaning **multipl
|
||||
|
||||
- CoValues keep their full edit histories, from which they derive their "current state".
|
||||
- The fact that this happens in an eventually-consistent way makes them [CRDTs](https://en.wikipedia.org/wiki/Conflict-free_replicated_data_type).
|
||||
- Having the full history also means that you often don't need explicit timestamps and author info - you get this for free as part of a CoValue's [edit metadata](/docs/using-covalues/metadata).
|
||||
- Having the full history also means that you often don't need explicit timestamps and author info - you get this for free as part of a CoValue's [edit metadata](/docs/using-covalues/history).
|
||||
|
||||
CoValues model JSON with CoMaps and CoLists, but also offer CoFeeds for simple per-user value feeds, and let you represent binary data with FileStreams.
|
||||
|
||||
@@ -31,11 +31,14 @@ Even before you know the details of how your app will work, you'll probably know
|
||||
Jazz makes it quick to declare schemas, since they are simple TypeScript classes:
|
||||
|
||||
<CodeGroup>
|
||||
{/* prettier-ignore */}
|
||||
```ts
|
||||
```ts twoslash
|
||||
import { co, CoMap, CoList } from "jazz-tools";
|
||||
class ListOfTasks extends CoList.Of(co.string) {}
|
||||
// ---cut---
|
||||
// schema.ts
|
||||
export class TodoProject extends CoMap {
|
||||
title = co.string;
|
||||
tasks = co.ref(ListOfTasks);
|
||||
title = co.string;
|
||||
tasks = co.ref(ListOfTasks);
|
||||
}
|
||||
```
|
||||
</CodeGroup>
|
||||
@@ -45,16 +48,28 @@ Here you can see how we extend a CoValue type and use `co` for declaring (collab
|
||||
Classes might look old-fashioned, but Jazz makes use of them being both types and values in TypeScript, letting you refer to either with a single definition and import.
|
||||
|
||||
<CodeGroup>
|
||||
{/* prettier-ignore */}
|
||||
```ts
|
||||
```ts twoslash
|
||||
// @filename: schema.ts
|
||||
import { co, CoMap, CoList } from "jazz-tools";
|
||||
|
||||
export class ListOfTasks extends CoList.Of(co.string) {}
|
||||
|
||||
export class TodoProject extends CoMap {
|
||||
title = co.string;
|
||||
tasks = co.ref(ListOfTasks);
|
||||
}
|
||||
// @filename: app.ts
|
||||
import { Group } from "jazz-tools";
|
||||
// ---cut---
|
||||
// app.ts
|
||||
import { TodoProject, ListOfTasks } from "./schema";
|
||||
|
||||
const project: TodoProject = TodoProject.create(
|
||||
{
|
||||
title: "New Project",
|
||||
tasks: ListOfTasks.create([], Group.create()),
|
||||
},
|
||||
Group.create()
|
||||
{
|
||||
title: "New Project",
|
||||
tasks: ListOfTasks.create([], Group.create()),
|
||||
},
|
||||
Group.create()
|
||||
);
|
||||
```
|
||||
</CodeGroup>
|
||||
@@ -63,17 +78,18 @@ const project: TodoProject = TodoProject.create(
|
||||
|
||||
### `CoMap` (declaration)
|
||||
|
||||
CoMaps are the most commonly used type of CoValue. They are the equivalent of JSON objects. (Collaborative editing follows a last-write-wins strategy per-key.)
|
||||
CoMaps are the most commonly used type of CoValue. They are the equivalent of JSON objects (Collaborative editing follows a last-write-wins strategy per-key).
|
||||
|
||||
You can either declare struct-like CoMaps:
|
||||
|
||||
<CodeGroup>
|
||||
{/* prettier-ignore */}
|
||||
```ts
|
||||
class Person extends CoMap {
|
||||
name = co.string;
|
||||
age = co.number;
|
||||
pet = co.optional.ref(Pet);
|
||||
```ts twoslash
|
||||
// schema.ts
|
||||
import { co, CoMap } from "jazz-tools";
|
||||
// ---cut---
|
||||
export class Task extends CoMap {
|
||||
title = co.string;
|
||||
completed = co.boolean;
|
||||
}
|
||||
```
|
||||
</CodeGroup>
|
||||
@@ -81,8 +97,13 @@ class Person extends CoMap {
|
||||
Or record-like CoMaps (key-value pairs, where keys are always `string`):
|
||||
|
||||
<CodeGroup>
|
||||
{/* prettier-ignore */}
|
||||
```ts
|
||||
```ts twoslash
|
||||
import { co, CoMap } from "jazz-tools";
|
||||
class Fruit extends CoMap {
|
||||
name = co.string;
|
||||
color = co.string;
|
||||
}
|
||||
// ---cut---
|
||||
class ColorToHex extends CoMap.Record(co.string) {}
|
||||
|
||||
class ColorToFruit extends CoMap.Record(co.ref(Fruit)) {}
|
||||
@@ -90,10 +111,10 @@ class ColorToFruit extends CoMap.Record(co.ref(Fruit)) {}
|
||||
</CodeGroup>
|
||||
|
||||
|
||||
See the corresponding sections for [creating](/docs/using-covalues/creation#comap-creation),
|
||||
See the corresponding sections for [creating](/docs/using-covalues/comaps#creating-comaps),
|
||||
[subscribing/loading](/docs/using-covalues/subscription-and-loading),
|
||||
[reading from](/docs/using-covalues/reading#comap-reading) and
|
||||
[writing to](/docs/using-covalues/writing#comap-writing) CoMaps.
|
||||
[reading from](/docs/using-covalues/comaps#reading-from-comaps) and
|
||||
[updating](/docs/using-covalues/comaps#updating-comaps) CoMaps.
|
||||
|
||||
### `CoList` (declaration)
|
||||
|
||||
@@ -102,38 +123,48 @@ CoLists are ordered lists and are the equivalent of JSON arrays. (They support c
|
||||
You define them by specifying the type of the items they contain:
|
||||
|
||||
<CodeGroup>
|
||||
{/* prettier-ignore */}
|
||||
```ts
|
||||
```ts twoslash
|
||||
import { co, CoList, CoMap } from "jazz-tools";
|
||||
class Task extends CoMap {
|
||||
title = co.string;
|
||||
completed = co.boolean;
|
||||
}
|
||||
// ---cut---
|
||||
class ListOfColors extends CoList.Of(co.string) {}
|
||||
|
||||
class ListOfTasks extends CoList.Of(co.ref(Task)) {}
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
See the corresponding sections for [creating](/docs/using-covalues/creation#colist-creation),
|
||||
See the corresponding sections for [creating](/docs/using-covalues/colists#creating-colists),
|
||||
[subscribing/loading](/docs/using-covalues/subscription-and-loading),
|
||||
[reading from](/docs/using-covalues/reading#colist-reading) and
|
||||
[writing to](/docs/using-covalues/writing#colist-writing) CoLists.
|
||||
[reading from](/docs/using-covalues/colists#reading-from-colists) and
|
||||
[updating](/docs/using-covalues/colists#updating-colists) CoLists.
|
||||
|
||||
### `CoFeed` (declaration)
|
||||
|
||||
CoFeeds are a special CoValue type that represent a feed of values for a set of users / sessions. (Each session of a user gets its own append-only feed.)
|
||||
CoFeeds are a special CoValue type that represent a feed of values for a set of users/sessions (Each session of a user gets its own append-only feed).
|
||||
|
||||
They allow easy access of the latest or all items belonging to a user or their sessions. This makes them particularly useful for user presence, reactions, notifications, etc.
|
||||
|
||||
You define them by specifying the type of feed item:
|
||||
|
||||
<CodeGroup>
|
||||
{/* prettier-ignore */}
|
||||
```ts
|
||||
```ts twoslash
|
||||
import { co, CoFeed, CoMap } from "jazz-tools";
|
||||
class Task extends CoMap {
|
||||
title = co.string;
|
||||
completed = co.boolean;
|
||||
}
|
||||
// ---cut---
|
||||
class FeedOfTasks extends CoFeed.Of(co.ref(Task)) {}
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
See the corresponding sections for [creating](/docs/using-covalues/creation#cofeed-creation),
|
||||
See the corresponding sections for [creating](/docs/using-covalues/cofeeds#creating-cofeeds),
|
||||
[subscribing/loading](/docs/using-covalues/subscription-and-loading),
|
||||
[reading from](/docs/using-covalues/reading#cofeed-reading) and
|
||||
[writing to](/docs/using-covalues/writing#cofeed-writing) CoFeeds.
|
||||
[reading from](/docs/using-covalues/cofeeds#reading-from-cofeeds) and
|
||||
[writing to](/docs/using-covalues/cofeeds#writing-to-cofeeds) CoFeeds.
|
||||
|
||||
### `FileStream` (declaration)
|
||||
|
||||
@@ -144,21 +175,22 @@ They allow you to upload and reference files, images, etc.
|
||||
You typically don't need to declare or extend them yourself, you simply refer to the built-in `FileStream` from another CoValue:
|
||||
|
||||
<CodeGroup>
|
||||
{/* prettier-ignore */}
|
||||
```ts
|
||||
```ts twoslash
|
||||
import { co, CoMap } from "jazz-tools";
|
||||
// ---cut---
|
||||
import { FileStream } from "jazz-tools";
|
||||
|
||||
class UserProfile extends CoMap {
|
||||
name = co.string;
|
||||
avatar = co.ref(FileStream);
|
||||
class Document extends CoMap {
|
||||
title = co.string;
|
||||
file = co.ref(FileStream);
|
||||
}
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
See the corresponding sections for [creating](/docs/using-covalues/creation#filestream-creation),
|
||||
See the corresponding sections for [creating](/docs/using-covalues/filestreams#creating-filestreams),
|
||||
[subscribing/loading](/docs/using-covalues/subscription-and-loading),
|
||||
[reading from](/docs/using-covalues/reading#filestream-reading) and
|
||||
[writing to](/docs/using-covalues/writing#filestream-writing) FileStreams.
|
||||
[reading from](/docs/using-covalues/filestreams#reading-from-filestreams) and
|
||||
[writing to](/docs/using-covalues/filestreams#writing-to-filestreams) FileStreams.
|
||||
|
||||
### `SchemaUnion` (declaration)
|
||||
|
||||
@@ -167,8 +199,9 @@ SchemaUnion is a helper type that allows you to load and refer to multiple subcl
|
||||
You declare them with a base class type and discriminating lambda, in which you have access to the `RawCoMap`, on which you can call `get` with the field name to get the discriminating value.
|
||||
|
||||
<CodeGroup>
|
||||
{/* prettier-ignore */}
|
||||
```ts
|
||||
```ts twoslash
|
||||
import { co } from "jazz-tools";
|
||||
// ---cut---
|
||||
import { SchemaUnion, CoMap } from "jazz-tools";
|
||||
|
||||
class BaseWidget extends CoMap {
|
||||
@@ -196,9 +229,9 @@ const WidgetUnion = SchemaUnion.Of<BaseWidget>((raw) => {
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
See the corresponding sections for [creating](/docs/using-covalues/creation#schemaunion-creation),
|
||||
See the corresponding sections for [creating](/docs/using-covalues/schemaunions#creating-schemaunions),
|
||||
[subscribing/loading](/docs/using-covalues/subscription-and-loading) and
|
||||
[narrowing](/docs/using-covalues/reading#schemaunion-narrowing) SchemaUnions.
|
||||
[narrowing](/docs/using-covalues/schemaunions#narrowing) SchemaUnions.
|
||||
|
||||
## CoValue field/item types
|
||||
|
||||
@@ -209,12 +242,11 @@ Now that we've seen the different types of CoValues, let's see more precisely ho
|
||||
You can declare primitive field types using the `co` declarer:
|
||||
|
||||
<CodeGroup>
|
||||
{/* prettier-ignore */}
|
||||
```ts
|
||||
import { co } from "jazz-tools";
|
||||
```ts twoslash
|
||||
import { co, CoMap, CoList } from "jazz-tools";
|
||||
|
||||
export class Person extends CoMap {
|
||||
title = co.string;
|
||||
title = co.string;
|
||||
}
|
||||
|
||||
export class ListOfColors extends CoList.Of(co.string) {}
|
||||
@@ -224,23 +256,25 @@ export class ListOfColors extends CoList.Of(co.string) {}
|
||||
Here's a quick overview of the primitive types you can use:
|
||||
|
||||
<CodeGroup>
|
||||
{/* prettier-ignore */}
|
||||
```ts
|
||||
co.string;
|
||||
co.number;
|
||||
co.boolean;
|
||||
co.null;
|
||||
co.Date;
|
||||
co.literal("waiting", "ready");
|
||||
```ts twoslash
|
||||
import { co } from "jazz-tools";
|
||||
// ---cut---
|
||||
co.string; // For simple strings
|
||||
co.number; // For numbers
|
||||
co.boolean; // For booleans
|
||||
co.null; // For null
|
||||
co.Date; // For dates
|
||||
co.literal("waiting", "ready"); // For enums
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
Finally, for more complex JSON data, that you *don't want to be collaborative internally* (but only ever update as a whole), you can use `co.json<T>()`:
|
||||
|
||||
<CodeGroup>
|
||||
{/* prettier-ignore */}
|
||||
```ts
|
||||
co.json<{ name: string }>();
|
||||
```ts twoslash
|
||||
import { co } from "jazz-tools";
|
||||
// ---cut---
|
||||
co.json<{ name: string }>(); // For JSON objects
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
@@ -257,13 +291,18 @@ The important caveat here is that **a referenced CoValue might or might not be l
|
||||
In Schemas, you declare Refs using the `co.ref<T>()` declarer:
|
||||
|
||||
<CodeGroup>
|
||||
{/* prettier-ignore */}
|
||||
```ts
|
||||
class Company extends CoMap {
|
||||
members = co.ref(ListOfPeople);
|
||||
```ts twoslash
|
||||
import { co, CoMap, CoList } from "jazz-tools";
|
||||
class Person extends CoMap {
|
||||
name = co.string;
|
||||
}
|
||||
|
||||
// ---cut---
|
||||
// schema.ts
|
||||
class ListOfPeople extends CoList.Of(co.ref(Person)) {}
|
||||
|
||||
class Company extends CoMap {
|
||||
members = co.ref(ListOfPeople);
|
||||
}
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
@@ -272,10 +311,14 @@ class ListOfPeople extends CoList.Of(co.ref(Person)) {}
|
||||
⚠️ If you want to make a referenced CoValue field optional, you *have to* use `co.optional.ref<T>()`: ⚠️
|
||||
|
||||
<CodeGroup>
|
||||
{/* prettier-ignore */}
|
||||
```ts
|
||||
```ts twoslash
|
||||
import { co, CoMap } from "jazz-tools";
|
||||
class Pet extends CoMap {
|
||||
name = co.string;
|
||||
}
|
||||
// ---cut---
|
||||
class Person extends CoMap {
|
||||
pet = co.optional.ref(Pet);
|
||||
pet = co.optional.ref(Pet);
|
||||
}
|
||||
```
|
||||
</CodeGroup>
|
||||
@@ -285,20 +328,25 @@ class Person extends CoMap {
|
||||
Since CoValue schemas are based on classes, you can easily add computed fields and methods:
|
||||
|
||||
<CodeGroup>
|
||||
{/* prettier-ignore */}
|
||||
```ts
|
||||
```ts twoslash
|
||||
import { co, CoMap } from "jazz-tools";
|
||||
function differenceInYears(date1: Date, date2: Date) {
|
||||
const diffTime = Math.abs(date1.getTime() - date2.getTime());
|
||||
return Math.ceil(diffTime / (1000 * 60 * 60 * 24 * 365.25));
|
||||
}
|
||||
// ---cut---
|
||||
class Person extends CoMap {
|
||||
firstName = co.string;
|
||||
lastName = co.string;
|
||||
dateOfBirth = co.Date;
|
||||
firstName = co.string;
|
||||
lastName = co.string;
|
||||
dateOfBirth = co.Date;
|
||||
|
||||
get name() {
|
||||
return `${this.firstName} ${this.lastName}`;
|
||||
}
|
||||
get name() {
|
||||
return `${this.firstName} ${this.lastName}`;
|
||||
}
|
||||
|
||||
ageAsOf(date: Date) {
|
||||
return differenceInYears(date, this.dateOfBirth);
|
||||
}
|
||||
ageAsOf(date: Date) {
|
||||
return differenceInYears(date, this.dateOfBirth);
|
||||
}
|
||||
}
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
437
homepage/homepage/content/docs/using-covalues/cotexts.mdx
Normal file
437
homepage/homepage/content/docs/using-covalues/cotexts.mdx
Normal file
@@ -0,0 +1,437 @@
|
||||
import { CodeGroup, ContentByFramework } from "@/components/forMdx";
|
||||
|
||||
export const metadata = { title: "CoTexts" };
|
||||
|
||||
# CoTexts
|
||||
|
||||
Jazz provides two CoValue types for collaborative text editing, collectively referred to as "CoText" values:
|
||||
|
||||
- **CoPlainText** for simple text editing without formatting
|
||||
- **CoRichText** for rich text with HTML-based formatting (extends CoPlainText)
|
||||
|
||||
Both types enable real-time collaborative editing of text content while maintaining consistency across multiple users.
|
||||
|
||||
**Note:** If you're looking for a quick way to add rich text editing to your app, check out [jazz-richtext-prosemirror](#using-rich-text-with-prosemirror).
|
||||
|
||||
<CodeGroup>
|
||||
```ts twoslash
|
||||
import { CoPlainText } from "jazz-tools";
|
||||
import { createJazzTestAccount } from 'jazz-tools/testing';
|
||||
const me = await createJazzTestAccount();
|
||||
|
||||
// ---cut---
|
||||
const note = CoPlainText.create("Meeting notes", { owner: me });
|
||||
|
||||
// Update the text
|
||||
note.applyDiff("Meeting notes for Tuesday");
|
||||
|
||||
console.log(note.toString()); // "Meeting notes for Tuesday"
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
For a full example of CoTexts in action, see [our Richtext example app](https://github.com/garden-co/jazz/tree/main/examples/richtext), which shows plain text and rich text editing.
|
||||
|
||||
## CoPlainText vs co.string
|
||||
|
||||
While `co.string` is perfect for simple text fields, `CoPlainText` is the right choice when you need:
|
||||
|
||||
- Multiple users editing the same text simultaneously
|
||||
- Fine-grained control over text edits (inserting, deleting at specific positions)
|
||||
- Character-by-character collaboration
|
||||
- Efficient merging of concurrent changes
|
||||
|
||||
Both support real-time updates, but `CoPlainText` provides specialized tools for collaborative editing scenarios.
|
||||
|
||||
## Creating CoText Values
|
||||
|
||||
CoText values are typically used as fields in your schemas:
|
||||
|
||||
<CodeGroup>
|
||||
```ts twoslash
|
||||
import { CoMap, CoPlainText, CoRichText, co } from "jazz-tools";
|
||||
|
||||
// ---cut---
|
||||
class Profile extends CoMap {
|
||||
name = co.string;
|
||||
bio = co.ref(CoPlainText); // Plain text field
|
||||
description = co.ref(CoRichText); // Rich text with formatting
|
||||
}
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
Create a CoText value with a simple string:
|
||||
|
||||
<CodeGroup>
|
||||
```ts twoslash
|
||||
import { CoPlainText, CoRichText, Account } from "jazz-tools";
|
||||
import { createJazzTestAccount } from 'jazz-tools/testing';
|
||||
const me = await createJazzTestAccount();
|
||||
|
||||
// ---cut---
|
||||
// Create plaintext with default ownership (current user)
|
||||
const note = CoPlainText.create("Meeting notes", { owner: me });
|
||||
|
||||
// Create rich text with HTML content
|
||||
const document = CoRichText.create("<p>Project <strong>overview</strong></p>",
|
||||
{ owner: me }
|
||||
);
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
### Ownership
|
||||
|
||||
Like other CoValues, you can specify ownership when creating CoTexts.
|
||||
|
||||
<CodeGroup>
|
||||
```ts twoslash
|
||||
import { CoPlainText, Group, Account } from "jazz-tools";
|
||||
import { createJazzTestAccount } from 'jazz-tools/testing';
|
||||
const me = await createJazzTestAccount();
|
||||
const colleagueAccount = await createJazzTestAccount();
|
||||
|
||||
// ---cut---
|
||||
// Create with shared ownership
|
||||
const teamGroup = Group.create();
|
||||
teamGroup.addMember(colleagueAccount, "writer");
|
||||
|
||||
const teamNote = CoPlainText.create("Team updates", { owner: teamGroup });
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
See [Groups as permission scopes](/docs/groups/intro) for more information on how to use groups to control access to CoText values.
|
||||
|
||||
## Reading Text
|
||||
|
||||
CoText values work like JavaScript strings:
|
||||
|
||||
<CodeGroup>
|
||||
```ts twoslash
|
||||
import { CoPlainText, Account } from "jazz-tools";
|
||||
import { createJazzTestAccount } from 'jazz-tools/testing';
|
||||
const me = await createJazzTestAccount();
|
||||
const note = CoPlainText.create("Meeting notes", { owner: me });
|
||||
|
||||
// ---cut---
|
||||
// Get the text content
|
||||
console.log(note.toString()); // "Meeting notes"
|
||||
|
||||
// Check the text length
|
||||
console.log(note.length); // 14
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
## Making Edits
|
||||
|
||||
Insert and delete text with intuitive methods:
|
||||
|
||||
<CodeGroup>
|
||||
```ts twoslash
|
||||
import { CoPlainText, Account } from "jazz-tools";
|
||||
import { createJazzTestAccount } from 'jazz-tools/testing';
|
||||
const me = await createJazzTestAccount();
|
||||
const note = CoPlainText.create("Meeting notes", { owner: me });
|
||||
|
||||
// ---cut---
|
||||
// Insert text at a specific position
|
||||
note.insertBefore(8, "weekly "); // "Meeting weekly notes"
|
||||
|
||||
// Insert after a position
|
||||
note.insertAfter(21, " for Monday"); // "Meeting weekly notes for Monday"
|
||||
|
||||
// Delete a range of text
|
||||
note.deleteRange({ from: 8, to: 15 }); // "Meeting notes for Monday"
|
||||
|
||||
// Apply a diff to update the entire text
|
||||
note.applyDiff("Team meeting notes for Tuesday");
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
### Applying Diffs
|
||||
|
||||
Use `applyDiff` to efficiently update text with minimal changes:
|
||||
|
||||
<CodeGroup>
|
||||
```ts twoslash
|
||||
import { CoPlainText, Account } from "jazz-tools";
|
||||
import { createJazzTestAccount } from 'jazz-tools/testing';
|
||||
const me = await createJazzTestAccount();
|
||||
|
||||
// ---cut---
|
||||
// Original text: "Team status update"
|
||||
const minutes = CoPlainText.create("Team status update", { owner: me });
|
||||
|
||||
// Replace the entire text with a new version
|
||||
minutes.applyDiff("Weekly team status update for Project X");
|
||||
|
||||
// Make partial changes
|
||||
let text = minutes.toString();
|
||||
text = text.replace("Weekly", "Monday");
|
||||
minutes.applyDiff(text); // Efficiently updates only what changed
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
Perfect for handling user input in form controls:
|
||||
|
||||
<ContentByFramework framework="react">
|
||||
<CodeGroup>
|
||||
```tsx twoslash
|
||||
import { CoPlainText, Account } from "jazz-tools";
|
||||
import { createJazzTestAccount } from 'jazz-tools/testing';
|
||||
import React, { useState } from "react";
|
||||
const me = await createJazzTestAccount();
|
||||
|
||||
// ---cut---
|
||||
function TextEditor() {
|
||||
const [note, setNote] = useState(CoPlainText.create("", { owner: me }));
|
||||
|
||||
return (
|
||||
<textarea
|
||||
value={note.toString()}
|
||||
onChange={(e) => {
|
||||
// Efficiently update only what the user changed
|
||||
note.applyDiff(e.target.value);
|
||||
}}
|
||||
/>
|
||||
);
|
||||
}
|
||||
```
|
||||
</CodeGroup>
|
||||
</ContentByFramework>
|
||||
|
||||
<ContentByFramework framework="vanilla">
|
||||
<CodeGroup>
|
||||
```ts twoslash
|
||||
import { CoPlainText, Account } from "jazz-tools";
|
||||
import { createJazzTestAccount } from 'jazz-tools/testing';
|
||||
const me = await createJazzTestAccount();
|
||||
|
||||
// ---cut---
|
||||
const note = CoPlainText.create("", { owner: me });
|
||||
|
||||
// Create and set up the textarea
|
||||
const textarea = document.createElement('textarea');
|
||||
textarea.value = note.toString();
|
||||
|
||||
// Add event listener for changes
|
||||
textarea.addEventListener('input', (e: Event) => {
|
||||
const target = e.target as HTMLTextAreaElement;
|
||||
// Efficiently update only what the user changed
|
||||
note.applyDiff(target.value);
|
||||
});
|
||||
|
||||
// Add the textarea to the document
|
||||
document.body.appendChild(textarea);
|
||||
```
|
||||
</CodeGroup>
|
||||
</ContentByFramework>
|
||||
|
||||
<ContentByFramework framework="vue">
|
||||
<CodeGroup>
|
||||
```vue twoslash
|
||||
<script setup lang="ts">
|
||||
import { ref, onMounted } from 'vue';
|
||||
import { CoPlainText } from "jazz-tools";
|
||||
import { createJazzTestAccount } from 'jazz-tools/testing';
|
||||
|
||||
const note = ref(null);
|
||||
const textContent = ref("");
|
||||
|
||||
onMounted(async () => {
|
||||
const me = await createJazzTestAccount();
|
||||
note.value = CoPlainText.create("", { owner: me });
|
||||
textContent.value = note.value.toString();
|
||||
});
|
||||
|
||||
function updateText(e) {
|
||||
if (note.value) {
|
||||
note.value.applyDiff(e.target.value);
|
||||
textContent.value = note.value.toString();
|
||||
}
|
||||
}
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<textarea
|
||||
:value="textContent"
|
||||
@input="updateText"
|
||||
/>
|
||||
</template>
|
||||
```
|
||||
</CodeGroup>
|
||||
</ContentByFramework>
|
||||
|
||||
<ContentByFramework framework="svelte">
|
||||
<CodeGroup>
|
||||
```svelte twoslash
|
||||
<script lang="ts">
|
||||
import { CoPlainText, Account } from "jazz-tools";
|
||||
import { createJazzTestAccount } from 'jazz-tools/testing';
|
||||
const me = await createJazzTestAccount();
|
||||
|
||||
const note = CoPlainText.create("", { owner: me });
|
||||
</script>
|
||||
|
||||
<textarea
|
||||
value={note.toString()}
|
||||
oninput={e => note.applyDiff(e.target.value)}
|
||||
/>
|
||||
```
|
||||
</CodeGroup>
|
||||
</ContentByFramework>
|
||||
|
||||
## Using Rich Text with ProseMirror
|
||||
|
||||
Jazz provides a dedicated plugin for integrating CoRichText with the popular ProseMirror editor. This plugin, [`jazz-richtext-prosemirror`](https://www.npmjs.com/package/jazz-richtext-prosemirror), enables bidirectional synchronization between your CoRichText instances and ProseMirror editors.
|
||||
|
||||
### ProseMirror Plugin Features
|
||||
|
||||
- **Bidirectional Sync**: Changes in the editor automatically update the CoRichText and vice versa
|
||||
- **Real-time Collaboration**: Multiple users can edit the same document simultaneously
|
||||
- **HTML Conversion**: Automatically converts between HTML (used by CoRichText) and ProseMirror's document model
|
||||
|
||||
### Installation
|
||||
|
||||
<CodeGroup>
|
||||
```bash
|
||||
pnpm add jazz-richtext-prosemirror \
|
||||
prosemirror-view \
|
||||
prosemirror-state \
|
||||
prosemirror-schema-basic
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
### Integration
|
||||
|
||||
<ContentByFramework framework="react-native">
|
||||
We don't currently have a React Native-specific example, but you need help you can [request one](https://github.com/garden-co/jazz/issues/new), or ask on [Discord](https://discord.gg/utDMjHYg42).
|
||||
</ContentByFramework>
|
||||
|
||||
<ContentByFramework framework="react-native-expo">
|
||||
We don't currently have a React Native Expo-specific example, but you need help please [request one](https://github.com/garden-co/jazz/issues/new), or ask on [Discord](https://discord.gg/utDMjHYg42).
|
||||
</ContentByFramework>
|
||||
|
||||
<ContentByFramework framework={["react", "react-native", "react-native-expo"]}>
|
||||
For use with React:
|
||||
<CodeGroup>
|
||||
```tsx twoslash
|
||||
class JazzProfile extends Profile {
|
||||
bio = co.ref(CoRichText);
|
||||
}
|
||||
|
||||
class JazzAccount extends Account {
|
||||
profile = co.ref(JazzProfile);
|
||||
}
|
||||
|
||||
declare module "jazz-react" {
|
||||
interface Register {
|
||||
Account: JazzAccount;
|
||||
}
|
||||
}
|
||||
|
||||
import { useAccount, useCoState } from "jazz-react";
|
||||
import { CoRichText, Account, Profile, co } from "jazz-tools";
|
||||
import React, { useEffect, useRef } from "react";
|
||||
// ---cut---
|
||||
// RichTextEditor.tsx
|
||||
import { createJazzPlugin } from "jazz-richtext-prosemirror";
|
||||
import { exampleSetup } from "prosemirror-example-setup";
|
||||
import { schema } from "prosemirror-schema-basic";
|
||||
import { EditorState } from "prosemirror-state";
|
||||
import { EditorView } from "prosemirror-view";
|
||||
|
||||
function RichTextEditor() {
|
||||
const { me } = useAccount({ resolve: { profile: true } });
|
||||
const editorRef = useRef<HTMLDivElement>(null);
|
||||
const viewRef = useRef<EditorView | null>(null);
|
||||
|
||||
useEffect(() => {
|
||||
if (!me?.profile.bio || !editorRef.current) return;
|
||||
|
||||
// Create the Jazz plugin for ProseMirror
|
||||
// Providing a CoRichText instance to the plugin to automatically sync changes
|
||||
const jazzPlugin = createJazzPlugin(me.profile.bio); // [!code ++]
|
||||
|
||||
// Set up ProseMirror with the Jazz plugin
|
||||
if (!viewRef.current) {
|
||||
viewRef.current = new EditorView(editorRef.current, {
|
||||
state: EditorState.create({
|
||||
schema,
|
||||
plugins: [
|
||||
...exampleSetup({ schema }),
|
||||
jazzPlugin, // [!code ++]
|
||||
],
|
||||
}),
|
||||
});
|
||||
}
|
||||
|
||||
return () => {
|
||||
if (viewRef.current) {
|
||||
viewRef.current.destroy();
|
||||
viewRef.current = null;
|
||||
}
|
||||
};
|
||||
}, [me?.profile.bio?.id]);
|
||||
|
||||
if (!me) return null;
|
||||
|
||||
return (
|
||||
<div className="border rounded">
|
||||
<div ref={editorRef} className="p-2" />
|
||||
</div>
|
||||
);
|
||||
}
|
||||
```
|
||||
</CodeGroup>
|
||||
</ContentByFramework>
|
||||
|
||||
<ContentByFramework framework="svelte">
|
||||
We don't currently have a Svelte-specific example, but you need help you can [request one](https://github.com/garden-co/jazz/issues/new), or ask on [Discord](https://discord.gg/utDMjHYg42).
|
||||
</ContentByFramework>
|
||||
|
||||
<ContentByFramework framework="vue">
|
||||
We don't currently have a Vue-specific example, but you need help you can [request one](https://github.com/garden-co/jazz/issues/new), or ask on [Discord](https://discord.gg/utDMjHYg42).
|
||||
</ContentByFramework>
|
||||
|
||||
<ContentByFramework framework={["vanilla", "svelte", "vue", "react-native", "react-native-expo"]}>
|
||||
For use without a framework:
|
||||
<CodeGroup>
|
||||
```js twoslash
|
||||
import { CoRichText } from "jazz-tools";
|
||||
import { createJazzPlugin } from "jazz-richtext-prosemirror";
|
||||
import { exampleSetup } from "prosemirror-example-setup";
|
||||
import { schema } from "prosemirror-schema-basic";
|
||||
import { EditorState } from "prosemirror-state";
|
||||
import { EditorView } from "prosemirror-view";
|
||||
|
||||
function setupRichTextEditor(coRichText, container) {
|
||||
// Create the Jazz plugin for ProseMirror
|
||||
// Providing a CoRichText instance to the plugin to automatically sync changes
|
||||
const jazzPlugin = createJazzPlugin(coRichText); // [!code ++]
|
||||
|
||||
// Set up ProseMirror with Jazz plugin
|
||||
const view = new EditorView(container, {
|
||||
state: EditorState.create({
|
||||
schema,
|
||||
plugins: [
|
||||
...exampleSetup({ schema }),
|
||||
jazzPlugin, // [!code ++]
|
||||
],
|
||||
}),
|
||||
});
|
||||
|
||||
// Return cleanup function
|
||||
return () => {
|
||||
view.destroy();
|
||||
};
|
||||
}
|
||||
|
||||
// Usage
|
||||
const document = CoRichText.create("<p>Initial content</p>", { owner: me });
|
||||
const editorContainer = document.getElementById("editor");
|
||||
const cleanup = setupRichTextEditor(document, editorContainer);
|
||||
|
||||
// Later when done with the editor
|
||||
cleanup();
|
||||
```
|
||||
</CodeGroup>
|
||||
</ContentByFramework>
|
||||
@@ -18,7 +18,8 @@ FileStreams provide automatic chunking when using the `createFromBlob` method, t
|
||||
In your schema, reference FileStreams like any other CoValue:
|
||||
|
||||
<CodeGroup>
|
||||
```ts
|
||||
```ts twoslash
|
||||
// schema.ts
|
||||
import { CoMap, FileStream, co } from "jazz-tools";
|
||||
|
||||
class Document extends CoMap {
|
||||
@@ -37,25 +38,32 @@ There are two main ways to create FileStreams: creating empty ones for manual da
|
||||
For files from input elements or drag-and-drop interfaces, use `createFromBlob`:
|
||||
|
||||
<CodeGroup>
|
||||
```ts
|
||||
```ts twoslash
|
||||
import { FileStream, Group } from "jazz-tools";
|
||||
const myGroup = Group.create();
|
||||
const progressBar: HTMLElement = document.querySelector('.progress-bar')!;
|
||||
|
||||
// ---cut---
|
||||
// From a file input
|
||||
const fileInput = document.querySelector('input[type="file"]');
|
||||
const fileInput = document.querySelector('input[type="file"]') as HTMLInputElement;
|
||||
|
||||
fileInput.addEventListener('change', async () => {
|
||||
const file = fileInput.files[0];
|
||||
if (file) {
|
||||
// Create FileStream from user-selected file
|
||||
const fileStream = await FileStream.createFromBlob(file);
|
||||
|
||||
// Or with progress tracking for better UX
|
||||
const fileWithProgress = await FileStream.createFromBlob(file, {
|
||||
onProgress: (progress) => {
|
||||
// progress is a value between 0 and 1
|
||||
const percent = Math.round(progress * 100);
|
||||
console.log(`Upload progress: ${percent}%`);
|
||||
progressBar.style.width = `${percent}%`;
|
||||
}
|
||||
});
|
||||
}
|
||||
const file = fileInput.files?.[0];
|
||||
if (!file) return;
|
||||
|
||||
// Create FileStream from user-selected file
|
||||
const fileStream = await FileStream.createFromBlob(file, { owner: myGroup });
|
||||
|
||||
// Or with progress tracking for better UX
|
||||
const fileWithProgress = await FileStream.createFromBlob(file, {
|
||||
onProgress: (progress) => {
|
||||
// progress is a value between 0 and 1
|
||||
const percent = Math.round(progress * 100);
|
||||
console.log(`Upload progress: ${percent}%`);
|
||||
progressBar.style.width = `${percent}%`;
|
||||
},
|
||||
owner: myGroup
|
||||
});
|
||||
});
|
||||
```
|
||||
</CodeGroup>
|
||||
@@ -65,11 +73,12 @@ fileInput.addEventListener('change', async () => {
|
||||
Create an empty FileStream when you want to manually [add binary data in chunks](/docs/using-covalues/filestreams#writing-to-filestreams):
|
||||
|
||||
<CodeGroup>
|
||||
```ts
|
||||
import { FileStream } from "jazz-tools";
|
||||
|
||||
```ts twoslash
|
||||
import { Group, FileStream } from "jazz-tools";
|
||||
const myGroup = Group.create();
|
||||
// ---cut---
|
||||
// Create a new empty FileStream
|
||||
const fileStream = FileStream.create();
|
||||
const fileStream = FileStream.create({ owner: myGroup } );
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
@@ -105,7 +114,10 @@ const teamFileStream = FileStream.create({ owner: teamGroup });
|
||||
To access the raw binary data and metadata:
|
||||
|
||||
<CodeGroup>
|
||||
```ts
|
||||
```ts twoslash
|
||||
import { FileStream } from "jazz-tools";
|
||||
const fileStream = FileStream.create();
|
||||
// ---cut---
|
||||
// Get all chunks and metadata
|
||||
const fileData = fileStream.getChunks();
|
||||
|
||||
@@ -127,7 +139,10 @@ if (fileData) {
|
||||
By default, `getChunks()` only returns data for completely synced `FileStream`s. To start using chunks from a `FileStream` that's currently still being synced use the `allowUnfinished` option:
|
||||
|
||||
<CodeGroup>
|
||||
```ts
|
||||
```ts twoslash
|
||||
import { FileStream } from "jazz-tools";
|
||||
const fileStream = FileStream.create();
|
||||
// ---cut---
|
||||
// Get data even if the stream isn't complete
|
||||
const partialData = fileStream.getChunks({ allowUnfinished: true });
|
||||
```
|
||||
@@ -138,10 +153,16 @@ const partialData = fileStream.getChunks({ allowUnfinished: true });
|
||||
For easier integration with web APIs, convert to a `Blob`:
|
||||
|
||||
<CodeGroup>
|
||||
```ts
|
||||
```ts twoslash
|
||||
import { FileStream } from "jazz-tools";
|
||||
const fileStream = FileStream.create();
|
||||
// ---cut---
|
||||
// Convert to a Blob
|
||||
const blob = fileStream.toBlob();
|
||||
|
||||
// Get the filename from the metadata
|
||||
const filename = fileStream.getChunks()?.fileName;
|
||||
|
||||
if (blob) {
|
||||
// Use with URL.createObjectURL
|
||||
const url = URL.createObjectURL(blob);
|
||||
@@ -149,7 +170,7 @@ if (blob) {
|
||||
// Create a download link
|
||||
const link = document.createElement('a');
|
||||
link.href = url;
|
||||
link.download = fileData?.fileName || 'document.pdf';
|
||||
link.download = filename || 'document.pdf';
|
||||
link.click();
|
||||
|
||||
// Clean up when done
|
||||
@@ -163,7 +184,10 @@ if (blob) {
|
||||
You can directly load a `FileStream` as a `Blob` when you only have its ID:
|
||||
|
||||
<CodeGroup>
|
||||
```ts
|
||||
```ts twoslash
|
||||
import { FileStream, type ID } from "jazz-tools";
|
||||
const fileStreamId = "co_z123" as ID<FileStream>;
|
||||
// ---cut---
|
||||
// Load directly as a Blob when you have an ID
|
||||
const blob = await FileStream.loadAsBlob(fileStreamId);
|
||||
|
||||
@@ -180,7 +204,10 @@ const partialBlob = await FileStream.loadAsBlob(fileStreamId, {
|
||||
Check if a `FileStream` is fully synced:
|
||||
|
||||
<CodeGroup>
|
||||
```ts
|
||||
```ts twoslash
|
||||
import { FileStream } from "jazz-tools";
|
||||
const fileStream = FileStream.create();
|
||||
// ---cut---
|
||||
if (fileStream.isBinaryStreamEnded()) {
|
||||
console.log('File is completely synced');
|
||||
} else {
|
||||
@@ -206,9 +233,12 @@ When creating a `FileStream` manually (not using `createFromBlob`), you need to
|
||||
Begin by providing metadata about the file:
|
||||
|
||||
<CodeGroup>
|
||||
```ts
|
||||
```ts twoslash
|
||||
import { FileStream, Group } from "jazz-tools";
|
||||
const myGroup = Group.create();
|
||||
// ---cut---
|
||||
// Create an empty FileStream
|
||||
const fileStream = FileStream.create();
|
||||
const fileStream = FileStream.create({ owner: myGroup });
|
||||
|
||||
// Initialize with metadata
|
||||
fileStream.start({
|
||||
@@ -224,9 +254,15 @@ fileStream.start({
|
||||
Add binary data in chunks - this helps with large files and progress tracking:
|
||||
|
||||
<CodeGroup>
|
||||
```ts
|
||||
// Create a sample Uint8Array (in real apps, this would be file data)
|
||||
const data = new Uint8Array([...]);
|
||||
```ts twoslash
|
||||
import { FileStream } from "jazz-tools";
|
||||
const fileStream = FileStream.create();
|
||||
const file = [0x48, 0x65, 0x6C, 0x6C, 0x6F, 0x20, 0x57, 0x6F, 0x72, 0x6C, 0x64]; // "Hello World" in ASCII
|
||||
const bytes = new Uint8Array(file);
|
||||
const arrayBuffer = bytes.buffer;
|
||||
|
||||
// ---cut---
|
||||
const data = new Uint8Array(arrayBuffer);
|
||||
|
||||
// For large files, break into chunks (e.g., 100KB each)
|
||||
const chunkSize = 1024 * 100;
|
||||
@@ -249,7 +285,10 @@ for (let i = 0; i < data.length; i += chunkSize) {
|
||||
Once all chunks are pushed, mark the `FileStream` as complete:
|
||||
|
||||
<CodeGroup>
|
||||
```ts
|
||||
```ts twoslash
|
||||
import { FileStream } from "jazz-tools";
|
||||
const fileStream = FileStream.create();
|
||||
// ---cut---
|
||||
// Finalize the upload
|
||||
fileStream.end();
|
||||
|
||||
@@ -266,9 +305,12 @@ Like other CoValues, you can subscribe to `FileStream`s to get notified of chang
|
||||
Load a `FileStream` when you have its ID:
|
||||
|
||||
<CodeGroup>
|
||||
```ts
|
||||
```ts twoslash
|
||||
import { FileStream, type ID } from "jazz-tools";
|
||||
const fileStreamId = "co_z123" as ID<FileStream>;
|
||||
// ---cut---
|
||||
// Load a FileStream by ID
|
||||
const fileStream = await FileStream.load(fileStreamId, []);
|
||||
const fileStream = await FileStream.load(fileStreamId);
|
||||
|
||||
if (fileStream) {
|
||||
console.log('FileStream loaded successfully');
|
||||
@@ -287,16 +329,20 @@ if (fileStream) {
|
||||
Subscribe to a `FileStream` to be notified when chunks are added or when the upload is complete:
|
||||
|
||||
<CodeGroup>
|
||||
```ts
|
||||
```ts twoslash
|
||||
import { FileStream, type ID } from "jazz-tools";
|
||||
import { createJazzTestAccount } from 'jazz-tools/testing';
|
||||
const fileStreamId = "co_z123" as ID<FileStream>;
|
||||
// ---cut---
|
||||
// Subscribe to a FileStream by ID
|
||||
const unsubscribe = FileStream.subscribe(fileStreamId, [], (fileStream) => {
|
||||
const unsubscribe = FileStream.subscribe(fileStreamId, (fileStream: FileStream) => {
|
||||
// Called whenever the FileStream changes
|
||||
console.log('FileStream updated');
|
||||
|
||||
// Get current status
|
||||
const chunks = fileStream.getChunks({ allowUnfinished: true });
|
||||
if (chunks) {
|
||||
const uploadedBytes = chunks.chunks.reduce((sum, chunk) => sum + chunk.length, 0);
|
||||
const uploadedBytes = chunks.chunks.reduce((sum: number, chunk: Uint8Array) => sum + chunk.length, 0);
|
||||
const totalBytes = chunks.totalSizeBytes || 1;
|
||||
const progress = Math.min(100, Math.round(uploadedBytes * 100 / totalBytes));
|
||||
|
||||
@@ -320,7 +366,10 @@ const unsubscribe = FileStream.subscribe(fileStreamId, [], (fileStream) => {
|
||||
If you need to wait for a `FileStream` to be fully synchronized across devices:
|
||||
|
||||
<CodeGroup>
|
||||
```ts
|
||||
```ts twoslash
|
||||
import { FileStream } from "jazz-tools";
|
||||
const fileStream = FileStream.create();
|
||||
// ---cut---
|
||||
// Wait for the FileStream to be fully synced
|
||||
await fileStream.waitForSync({
|
||||
timeout: 5000 // Optional timeout in ms
|
||||
|
||||
@@ -26,4 +26,8 @@ export const features = {
|
||||
clerk: "Clerk auth",
|
||||
inviteLink: "Invite link",
|
||||
coFeed: "CoFeed",
|
||||
coRichText: "CoRichText",
|
||||
coPlainText: "CoPlainText",
|
||||
serverWorker: "Server worker",
|
||||
inbox: "Inbox",
|
||||
};
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
import DocsLayout from "@/components/docs/DocsLayout";
|
||||
import { DocNav } from "@/components/docs/DocsNav";
|
||||
import { Toc } from "@stefanprobst/rehype-extract-toc";
|
||||
import { Prose } from "@garden-co/design-system/src/components/molecules/Prose";
|
||||
import { Toc } from "@stefanprobst/rehype-extract-toc";
|
||||
|
||||
export async function getMdxSource(framework: string, slugPath?: string) {
|
||||
// Try to import the framework-specific file first
|
||||
@@ -42,7 +42,7 @@ export async function getDocMetadata(framework: string, slug?: string[]) {
|
||||
|
||||
function DocProse({ children }: { children: React.ReactNode }) {
|
||||
return (
|
||||
<Prose className="overflow-x-hidden lg:overflow-x-visible lg:flex-1 pb-8 pt-[calc(61px+2rem)] md:pt-8 md:max-w-3xl mx-auto">
|
||||
<Prose className="overflow-hidden pb-8 pt-[calc(61px+2rem)] md:pt-8 md:max-w-3xl mx-auto">
|
||||
{children}
|
||||
</Prose>
|
||||
);
|
||||
@@ -55,23 +55,8 @@ export async function DocPage({
|
||||
framework: string;
|
||||
slug?: string[];
|
||||
}) {
|
||||
const slugPath = slug?.join("/");
|
||||
|
||||
try {
|
||||
const mdxSource = await getMdxSource(framework, slugPath);
|
||||
|
||||
const {
|
||||
default: Content,
|
||||
tableOfContents = [],
|
||||
headingsFrameworkVisibility = {},
|
||||
} = mdxSource;
|
||||
|
||||
// Remove items that should not be shown for the current framework
|
||||
const tocItems = (tableOfContents as Toc).filter(({ id }) =>
|
||||
id && id in headingsFrameworkVisibility
|
||||
? headingsFrameworkVisibility[id]?.includes(framework)
|
||||
: true,
|
||||
);
|
||||
const { Content, tocItems } = await getMdxWithToc(framework, slug);
|
||||
|
||||
return (
|
||||
<DocsLayout nav={<DocNav />} tocItems={tocItems}>
|
||||
@@ -93,3 +78,50 @@ export async function DocPage({
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
export async function getMdxWithToc(framework: string, slug?: string[]) {
|
||||
const slugPath = slug?.join("/");
|
||||
const mdxSource = await getMdxSource(framework, slugPath);
|
||||
|
||||
const {
|
||||
default: Content,
|
||||
tableOfContents,
|
||||
headingsFrameworkVisibility,
|
||||
} = mdxSource;
|
||||
|
||||
// Remove items that should not be shown for the current framework
|
||||
const tocItems = filterTocItemsForFramework(
|
||||
tableOfContents as Toc,
|
||||
framework,
|
||||
headingsFrameworkVisibility
|
||||
);
|
||||
|
||||
return {
|
||||
Content,
|
||||
tocItems,
|
||||
};
|
||||
}
|
||||
function filterTocItemsForFramework(
|
||||
tocItems: Toc,
|
||||
framework: string,
|
||||
headingsFrameworkVisibility: Record<string, string[]>
|
||||
): Toc {
|
||||
return tocItems
|
||||
.map(item => {
|
||||
const isVisible =
|
||||
!item.id || !(item.id in headingsFrameworkVisibility) ||
|
||||
headingsFrameworkVisibility[item.id]?.includes(framework);
|
||||
|
||||
if (!isVisible) return null;
|
||||
|
||||
const filteredChildren = item.children
|
||||
? filterTocItemsForFramework(item.children, framework, headingsFrameworkVisibility)
|
||||
: [];
|
||||
|
||||
return {
|
||||
...item,
|
||||
children: filteredChildren,
|
||||
};
|
||||
})
|
||||
.filter(Boolean) as Toc;
|
||||
}
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user