@instructure/platform-notebook 0.2.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,11 @@
1
+ import { HighlightTheme } from './highlighter';
2
+ import { REACTION_TYPE } from './types';
3
+ export type HighlightProps = {
4
+ children?: string;
5
+ type?: REACTION_TYPE;
6
+ isCardActive?: boolean;
7
+ theme: HighlightTheme;
8
+ };
9
+ export declare const Highlight: ({ children, type, isCardActive, theme, }: HighlightProps) => import("react/jsx-runtime").JSX.Element;
10
+ export declare const HighlightError: () => import("react/jsx-runtime").JSX.Element;
11
+ //# sourceMappingURL=Highlight.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Highlight.d.ts","sourceRoot":"","sources":["../src/Highlight.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAGnD,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAEvC,MAAM,MAAM,cAAc,GAAG;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE,aAAa,CAAA;IACpB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,KAAK,EAAE,cAAc,CAAA;CACtB,CAAA;AAoBD,eAAO,MAAM,SAAS,GAAI,0CAKvB,cAAc,4CAsBhB,CAAA;AAED,eAAO,MAAM,cAAc,+CAa1B,CAAA"}
@@ -0,0 +1,32 @@
1
+ import { ReactNode } from 'react';
2
+ import { HighlightTheme } from './highlighter';
3
+ import { REACTION_TYPE } from './types';
4
+ export type NoteCardTheme = {
5
+ importantBorderColor: string;
6
+ confusingBorderColor: string;
7
+ };
8
+ export type NoteCardProps = {
9
+ noteId: string;
10
+ date: Date | string;
11
+ type: REACTION_TYPE;
12
+ highlight?: string | null;
13
+ note?: string;
14
+ onClick?: () => void;
15
+ onDelete?: (noteId: string) => void;
16
+ onSaveNote?: (noteId: string, noteText: string) => void;
17
+ onTypeChange?: (noteId: string, type: REACTION_TYPE) => void;
18
+ isActive?: boolean;
19
+ isPanelView?: boolean;
20
+ courseName?: string;
21
+ locale?: string;
22
+ highlightTheme: HighlightTheme;
23
+ cardTheme: NoteCardTheme;
24
+ renderLink?: (props: {
25
+ href: string;
26
+ children: ReactNode;
27
+ ariaLabel?: string;
28
+ }) => ReactNode;
29
+ href?: string;
30
+ };
31
+ export declare const NoteCard: ({ noteId, date, highlight, note, type, onClick, onDelete, onSaveNote, onTypeChange, isActive, isPanelView, courseName, locale, highlightTheme, cardTheme, renderLink, href, }: NoteCardProps) => string | number | boolean | Iterable<ReactNode> | import("react/jsx-runtime").JSX.Element | null | undefined;
32
+ //# sourceMappingURL=NoteCard.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"NoteCard.d.ts","sourceRoot":"","sources":["../src/NoteCard.tsx"],"names":[],"mappings":"AAQA,OAAO,EAAsB,KAAK,SAAS,EAAY,MAAM,OAAO,CAAA;AAEpE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAInD,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAEvC,MAAM,MAAM,aAAa,GAAG;IAC1B,oBAAoB,EAAE,MAAM,CAAA;IAC5B,oBAAoB,EAAE,MAAM,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,IAAI,GAAG,MAAM,CAAA;IACnB,IAAI,EAAE,aAAa,CAAA;IACnB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,IAAI,CAAA;IACpB,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAA;IACnC,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAA;IACvD,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,KAAK,IAAI,CAAA;IAC5D,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,cAAc,EAAE,cAAc,CAAA;IAC9B,SAAS,EAAE,aAAa,CAAA;IACxB,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,SAAS,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,SAAS,CAAA;IAC5F,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAWD,eAAO,MAAM,QAAQ,GAAI,+KAkBtB,aAAa,iHA0Qf,CAAA"}
@@ -0,0 +1,8 @@
1
+ import { REACTION_TYPE } from './types';
2
+ export type NoteChipProps = {
3
+ type: REACTION_TYPE;
4
+ onTypeChange?: (type: REACTION_TYPE) => void;
5
+ renderAsMenuTrigger?: boolean;
6
+ };
7
+ export declare const NoteChip: ({ type, onTypeChange, renderAsMenuTrigger }: NoteChipProps) => import("react/jsx-runtime").JSX.Element;
8
+ //# sourceMappingURL=NoteChip.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"NoteChip.d.ts","sourceRoot":"","sources":["../src/NoteChip.tsx"],"names":[],"mappings":"AAKA,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAEvC,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,aAAa,CAAA;IACnB,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,aAAa,KAAK,IAAI,CAAA;IAC5C,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAC9B,CAAA;AAeD,eAAO,MAAM,QAAQ,GAAI,6CAAqD,aAAa,4CAgD1F,CAAA"}
@@ -0,0 +1,7 @@
1
+ import { REACTION_TYPE } from './types';
2
+ export type NoteReactionMenuProps = {
3
+ currentType?: REACTION_TYPE;
4
+ onSelectReaction: (reaction: REACTION_TYPE) => void;
5
+ };
6
+ export declare const NoteReactionMenu: ({ currentType, onSelectReaction }: NoteReactionMenuProps) => import("react/jsx-runtime").JSX.Element;
7
+ //# sourceMappingURL=NoteReactionMenu.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"NoteReactionMenu.d.ts","sourceRoot":"","sources":["../src/NoteReactionMenu.tsx"],"names":[],"mappings":"AAIA,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAEvC,MAAM,MAAM,qBAAqB,GAAG;IAClC,WAAW,CAAC,EAAE,aAAa,CAAA;IAC3B,gBAAgB,EAAE,CAAC,QAAQ,EAAE,aAAa,KAAK,IAAI,CAAA;CACpD,CAAA;AAED,eAAO,MAAM,gBAAgB,GAAI,mCAAmC,qBAAqB,4CA2BxF,CAAA"}
@@ -1 +1 @@
1
- {"version":3,"file":"TranslationsContext.d.ts","sourceRoot":"","sources":["../src/TranslationsContext.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAiB,KAAK,SAAS,EAAc,MAAM,OAAO,CAAA;AACjE,OAAO,cAAc,MAAM,oBAAoB,CAAA;AAE/C,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,OAAO,cAAc,EAAE,MAAM,CAAC,CAAA;AAE9E,MAAM,MAAM,iBAAiB,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,MAAM,CAAA;AAE1F,MAAM,WAAW,2BAA2B;IAC1C,YAAY,EAAE,oBAAoB,CAAA;IAClC,SAAS,EAAE,iBAAiB,CAAA;CAC7B;AAUD,MAAM,WAAW,iCAAiC;IAChD,YAAY,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAC5C,SAAS,CAAC,EAAE,iBAAiB,CAAA;IAC7B,QAAQ,EAAE,SAAS,CAAA;CACpB;AAED,wBAAgB,4BAA4B,CAAC,EAC3C,YAAY,EACZ,SAAS,EACT,QAAQ,GACT,EAAE,iCAAiC,2CAQnC;AAED,wBAAgB,uBAAuB,IAAI,2BAA2B,CAMrE"}
1
+ {"version":3,"file":"TranslationsContext.d.ts","sourceRoot":"","sources":["../src/TranslationsContext.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAiB,KAAK,SAAS,EAAuB,MAAM,OAAO,CAAA;AAC1E,OAAO,cAAc,MAAM,oBAAoB,CAAA;AAE/C,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,OAAO,cAAc,EAAE,MAAM,CAAC,CAAA;AAE9E,MAAM,MAAM,iBAAiB,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,MAAM,CAAA;AAE1F,MAAM,WAAW,2BAA2B;IAC1C,YAAY,EAAE,oBAAoB,CAAA;IAClC,SAAS,EAAE,iBAAiB,CAAA;CAC7B;AAUD,MAAM,WAAW,iCAAiC;IAChD,YAAY,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAC5C,SAAS,CAAC,EAAE,iBAAiB,CAAA;IAC7B,QAAQ,EAAE,SAAS,CAAA;CACpB;AAED,wBAAgB,4BAA4B,CAAC,EAC3C,YAAY,EACZ,SAAS,EACT,QAAQ,GACT,EAAE,iCAAiC,2CAUnC;AAED,wBAAgB,uBAAuB,IAAI,2BAA2B,CAMrE"}
@@ -15,6 +15,7 @@ export type DomHighlightConfig = {
15
15
  onClick?: () => void;
16
16
  selectedNoteId?: string | null;
17
17
  };
18
+ export declare const createTransparentColor: (hex: string, opacity: number) => string;
18
19
  export declare const isNodeInRange: (range: Range, node: Node) => boolean;
19
20
  export declare const addHighlight: (range: Range, highlightProps: DomHighlightConfig, theme: HighlightTheme) => void;
20
21
  export declare const removeHighlights: (highlightProps: DomHighlightConfig) => void;
@@ -1 +1 @@
1
- {"version":3,"file":"highlighter.d.ts","sourceRoot":"","sources":["../src/highlighter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AASvC,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE;QACN,mBAAmB,EAAE,MAAM,CAAA;QAC3B,mBAAmB,EAAE,MAAM,CAAA;QAC3B,kBAAkB,EAAE,MAAM,CAAA;QAC1B,kBAAkB,EAAE,MAAM,CAAA;KAC3B,CAAA;IACD,gBAAgB,EAAE,MAAM,CAAA;IACxB,eAAe,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,aAAa,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,IAAI,CAAA;IACpB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC/B,CAAA;AAUD,eAAO,MAAM,aAAa,GAAI,OAAO,KAAK,EAAE,MAAM,IAAI,YAOrD,CAAA;AA4CD,eAAO,MAAM,YAAY,GACvB,OAAO,KAAK,EACZ,gBAAgB,kBAAkB,EAClC,OAAO,cAAc,SAiJtB,CAAA;AAmBD,eAAO,MAAM,gBAAgB,GAAI,gBAAgB,kBAAkB,SAmBlE,CAAA"}
1
+ {"version":3,"file":"highlighter.d.ts","sourceRoot":"","sources":["../src/highlighter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AASvC,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE;QACN,mBAAmB,EAAE,MAAM,CAAA;QAC3B,mBAAmB,EAAE,MAAM,CAAA;QAC3B,kBAAkB,EAAE,MAAM,CAAA;QAC1B,kBAAkB,EAAE,MAAM,CAAA;KAC3B,CAAA;IACD,gBAAgB,EAAE,MAAM,CAAA;IACxB,eAAe,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,aAAa,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,IAAI,CAAA;IACpB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC/B,CAAA;AAGD,eAAO,MAAM,sBAAsB,GAAI,KAAK,MAAM,EAAE,SAAS,MAAM,KAAG,MAKrE,CAAA;AAED,eAAO,MAAM,aAAa,GAAI,OAAO,KAAK,EAAE,MAAM,IAAI,YAOrD,CAAA;AA4CD,eAAO,MAAM,YAAY,GACvB,OAAO,KAAK,EACZ,gBAAgB,kBAAkB,EAClC,OAAO,cAAc,SAiJtB,CAAA;AAmBD,eAAO,MAAM,gBAAgB,GAAI,gBAAgB,kBAAkB,SAmBlE,CAAA"}
package/dist/index.d.ts CHANGED
@@ -1,9 +1,13 @@
1
- export { addHighlight, type DomHighlightConfig, type HighlightTheme, removeHighlights, } from './highlighter';
1
+ export { Highlight, HighlightError, type HighlightProps } from './Highlight';
2
+ export { addHighlight, createTransparentColor, type DomHighlightConfig, type HighlightTheme, removeHighlights, } from './highlighter';
2
3
  export { useCreateNote } from './hooks/useCreateNote';
3
4
  export { useDeleteNote } from './hooks/useDeleteNote';
4
5
  export { type UseGetNotesOptions, useGetNotes } from './hooks/useGetNotes';
5
6
  export { type UpdateNoteParams, useUpdateNote } from './hooks/useUpdateNote';
6
7
  export { type NotebookContextValue, NotebookProvider, type NotebookProviderProps, useNotebook, } from './NotebookProvider';
8
+ export { NoteCard, type NoteCardProps, type NoteCardTheme } from './NoteCard';
9
+ export { NoteChip, type NoteChipProps } from './NoteChip';
10
+ export { NoteReactionMenu, type NoteReactionMenuProps } from './NoteReactionMenu';
7
11
  export { RangeAnchor } from './RangeAnchor';
8
12
  export { TextPosition } from './TextPosition';
9
13
  export { TextPositionAnchor } from './TextPositionAnchor';
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,gBAAgB,GACjB,MAAM,eAAe,CAAA;AACtB,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AAC1E,OAAO,EAAE,KAAK,gBAAgB,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AAC5E,OAAO,EACL,KAAK,oBAAoB,EACzB,gBAAgB,EAChB,KAAK,qBAAqB,EAC1B,WAAW,GACZ,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EACL,KAAK,oBAAoB,EACzB,KAAK,iBAAiB,EACtB,uBAAuB,GACxB,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EACL,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,iBAAiB,EACtB,KAAK,cAAc,EACnB,KAAK,iBAAiB,EACtB,KAAK,sBAAsB,EAC3B,KAAK,WAAW,EAChB,KAAK,kBAAkB,EACvB,KAAK,QAAQ,EACb,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,aAAa,EACb,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,GAC5B,MAAM,SAAS,CAAA;AAChB,OAAO,EACL,YAAY,EACZ,aAAa,EACb,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,SAAS,CAAA;AAChB,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,KAAK,cAAc,EAAE,MAAM,aAAa,CAAA;AAC5E,OAAO,EACL,YAAY,EACZ,sBAAsB,EACtB,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,gBAAgB,GACjB,MAAM,eAAe,CAAA;AACtB,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AAC1E,OAAO,EAAE,KAAK,gBAAgB,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AAC5E,OAAO,EACL,KAAK,oBAAoB,EACzB,gBAAgB,EAChB,KAAK,qBAAqB,EAC1B,WAAW,GACZ,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,QAAQ,EAAE,KAAK,aAAa,EAAE,KAAK,aAAa,EAAE,MAAM,YAAY,CAAA;AAC7E,OAAO,EAAE,QAAQ,EAAE,KAAK,aAAa,EAAE,MAAM,YAAY,CAAA;AACzD,OAAO,EAAE,gBAAgB,EAAE,KAAK,qBAAqB,EAAE,MAAM,oBAAoB,CAAA;AACjF,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EACL,KAAK,oBAAoB,EACzB,KAAK,iBAAiB,EACtB,uBAAuB,GACxB,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EACL,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,iBAAiB,EACtB,KAAK,cAAc,EACnB,KAAK,iBAAiB,EACtB,KAAK,sBAAsB,EAC3B,KAAK,WAAW,EAChB,KAAK,kBAAkB,EACvB,KAAK,QAAQ,EACb,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,aAAa,EACb,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,GAC5B,MAAM,SAAS,CAAA;AAChB,OAAO,EACL,YAAY,EACZ,aAAa,EACb,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,SAAS,CAAA;AAChB,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA"}