@react-text-game/core 0.5.12 → 0.5.13
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.
|
@@ -71,6 +71,30 @@ export interface TextComponent extends BaseComponent {
|
|
|
71
71
|
* ```
|
|
72
72
|
*/
|
|
73
73
|
className?: string;
|
|
74
|
+
/**
|
|
75
|
+
* When `true`, renders the content as raw HTML using `dangerouslySetInnerHTML`.
|
|
76
|
+
* This allows using HTML markup in `.ts` files without needing JSX/TSX.
|
|
77
|
+
*
|
|
78
|
+
* @defaultValue false
|
|
79
|
+
*
|
|
80
|
+
* @remarks
|
|
81
|
+
* - Only works when `content` is a string. If `content` is a ReactNode,
|
|
82
|
+
* this prop is ignored and the content is rendered normally.
|
|
83
|
+
* - The browser handles HTML parsing natively and is forgiving with malformed HTML.
|
|
84
|
+
* - **Security:** Since game authors control their own content, XSS is not
|
|
85
|
+
* a concern. Do not use with untrusted user input.
|
|
86
|
+
*
|
|
87
|
+
* @example
|
|
88
|
+
* ```typescript
|
|
89
|
+
* // In a .ts file (no JSX needed)
|
|
90
|
+
* {
|
|
91
|
+
* type: 'text',
|
|
92
|
+
* content: '<strong>Bold</strong> and <em>italic</em> text',
|
|
93
|
+
* props: { isHTML: true }
|
|
94
|
+
* }
|
|
95
|
+
* ```
|
|
96
|
+
*/
|
|
97
|
+
isHTML?: boolean;
|
|
74
98
|
};
|
|
75
99
|
}
|
|
76
100
|
/**
|
|
@@ -799,13 +823,18 @@ export interface ConversationComponent extends BaseComponent {
|
|
|
799
823
|
* based on the `type` property when rendering or processing components.
|
|
800
824
|
*/
|
|
801
825
|
export type Component = TextComponent | HeaderComponent | ImageComponent | VideoComponent | ActionsComponent | ConversationComponent | AnotherStoryComponent;
|
|
826
|
+
/**
|
|
827
|
+
* Array of story components.
|
|
828
|
+
* Used to define the structure of a story passage.
|
|
829
|
+
*/
|
|
830
|
+
export type StoryComponents = Array<Component>;
|
|
802
831
|
/**
|
|
803
832
|
* Function type for story content generation.
|
|
804
833
|
* Receives props and returns an array of components to display.
|
|
805
834
|
*
|
|
806
835
|
* @template T - Type of props passed to the story (extends InitVarsType)
|
|
807
836
|
* @param props - Properties used for conditional rendering or dynamic content
|
|
808
|
-
* @returns Array of components
|
|
837
|
+
* @returns Array of story components to render
|
|
809
838
|
*
|
|
810
839
|
* @example
|
|
811
840
|
* ```typescript
|
|
@@ -840,7 +869,7 @@ export type Component = TextComponent | HeaderComponent | ImageComponent | Video
|
|
|
840
869
|
* - Access reactive game state through props for dynamic content
|
|
841
870
|
* - Return value is memoized based on props
|
|
842
871
|
*/
|
|
843
|
-
export type StoryContent = <T extends InitVarsType = EmptyObject>(props: T) =>
|
|
872
|
+
export type StoryContent = <T extends InitVarsType = EmptyObject>(props: T) => StoryComponents;
|
|
844
873
|
/**
|
|
845
874
|
* Configuration options for story appearance and behavior.
|
|
846
875
|
* Applied to the entire story passage.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/passages/story/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAE/E;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC1B;;;;;;;;OAQG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,YAAY,CAAC;CACxD;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,aAAc,SAAQ,aAAa;IAChD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,OAAO,EAAE,SAAS,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE;QACJ;;;;;;;;WAQG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/passages/story/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAE/E;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC1B;;;;;;;;OAQG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,YAAY,CAAC;CACxD;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,aAAc,SAAQ,aAAa;IAChD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,OAAO,EAAE,SAAS,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE;QACJ;;;;;;;;WAQG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;;;;;;;;;;;;;;;;;;;WAsBG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;KACpB,CAAC;CACL;AAED;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAEhD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,eAAgB,SAAQ,aAAa;IAClD;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IAEf;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE;QACJ;;;;;WAKG;QACH,KAAK,CAAC,EAAE,WAAW,CAAC;QAEpB;;;;;;;;WAQG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACL;AACD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,cAAe,SAAQ,aAAa;IACjD;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;;;;;;;;OAUG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE;QACJ;;;;;WAKG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;;;;;;WAOG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;;;;;;WASG;QACH,YAAY,CAAC,EAAE,OAAO,CAAC;QAEvB;;;;;;;;;;;;;;;;;;WAkBG;QACH,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;KACxB,CAAC;CACL;AACD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,cAAe,SAAQ,aAAa;IACjD;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;;;;;;;;OAUG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE;QACJ;;;;;;;WAOG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;;;;;WAQG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB;;;;;;;;WAQG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB;;;;;;;WAOG;QACH,IAAI,CAAC,EAAE,OAAO,CAAC;QAEf;;;;;;;;WAQG;QACH,KAAK,CAAC,EAAE,OAAO,CAAC;KACnB,CAAC;CACL;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,MAAM,UAAU,GAAG;IACrB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;;;;;;;OAWG;IACH,MAAM,EAAE,MAAM,IAAI,CAAC;IAEnB;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC;IAEpB;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,EAAE,aAAa,CAAC;IAExB;;;;;;;;;OASG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;OAGG;IACH,OAAO,CAAC,EAAE;QACN;;;;;;;WAOG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,CAAC;QAE/C;;;;;;;WAOG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;IAEF;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,gBAAiB,SAAQ,aAAa;IACnD;;OAEG;IACH,IAAI,EAAE,SAAS,CAAC;IAEhB;;;OAGG;IACH,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE;QACJ;;;;;;;;WAQG;QACH,SAAS,CAAC,EAAE,YAAY,GAAG,UAAU,CAAC;QAEtC;;;;;;;WAOG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACL;AACD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,qBAAsB,SAAQ,aAAa;IACxD;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;;;;;;;;;;;;OAaG;IACH,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,GAAG,OAAO,CAAC;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC7B;;OAEG;IACH,GAAG,CAAC,EAAE;QACF;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;;;;;;;WASG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IAEF;;;OAGG;IACH,OAAO,EAAE,SAAS,CAAC;IAEnB;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,EAAE,IAAI,MAAM,EAAE,CAAC;IAErB;;;;;;;;OAQG;IACH,IAAI,CAAC,EAAE,sBAAsB,CAAC;IAE9B;;OAEG;IACH,KAAK,CAAC,EAAE;QACJ;;WAEG;QACH,UAAU,CAAC,EAAE;YACT;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;;eAGG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;YAEjB;;;eAGG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;SACnB,CAAC;KACL,CAAC;CACL,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,WAAW,CAAC;AAEvD;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,QAAQ,GAAG,SAAS,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAM,WAAW,qBAAsB,SAAQ,aAAa;IACxD;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;;OAGG;IACH,OAAO,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAEnC;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,EAAE,sBAAsB,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE;QACJ;;;;;;;;;;;;;;;WAeG;QACH,OAAO,CAAC,EAAE,mBAAmB,CAAC;QAE9B;;;;;;;WAOG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACL;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,SAAS,GACf,aAAa,GACb,eAAe,GACf,cAAc,GACd,cAAc,GACd,gBAAgB,GAChB,qBAAqB,GACrB,qBAAqB,CAAC;AAE5B;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,SAAS,YAAY,GAAG,WAAW,EAC5D,KAAK,EAAE,CAAC,KACP,eAAe,CAAC;AAErB;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,YAAY,GAAG;IACvB;;OAEG;IACH,UAAU,CAAC,EAAE;QACT;;;;;;;;;;;;;;WAcG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAC;KACnC,CAAC;IAEF;;OAEG;IACH,UAAU,CAAC,EAAE;QACT;;;;;;;;WAQG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;;;;;;WAQG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACL,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@react-text-game/core",
|
|
3
|
-
"version": "0.5.
|
|
3
|
+
"version": "0.5.13",
|
|
4
4
|
"description": "A powerful React-based text game engine with reactive state management, passage-based navigation, and persistent save system for building interactive narrative experiences",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/index.js",
|