solid-ctrl-flow 1.0.17 → 1.0.18

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.
package/dist/index.d.ts CHANGED
@@ -60,11 +60,11 @@ export declare function Case(props: {
60
60
  * @param name Name to give to the context of the extractor
61
61
  */
62
62
  export declare function createExtractor(name?: string): {
63
- /** Bound {@link Dest} */
63
+ /** Shows the content of the closest {@link Source} child of the closest {@link Joint} ancestor of this component */
64
64
  Dest: () => JSX.Element;
65
- /** Bound {@link Source} */
65
+ /** Puts its content inside of a {@link Dest} if it is available; There is no need to include this component on the DOM tree */
66
66
  Source: (props: Info) => JSX.Element;
67
- /** Bound {@link Joint} */
67
+ /** Allows {@link Dest} and {@link Source} childrens to communicate with each other */
68
68
  Joint: (props: {
69
69
  children: JSX.Element;
70
70
  }) => JSX.Element;
package/dist/index.mjs CHANGED
@@ -75,11 +75,11 @@ function createExtractor(name = "extractor") {
75
75
  name
76
76
  });
77
77
  return {
78
- /** Bound {@link Dest} */
78
+ /** Shows the content of the closest {@link Source} child of the closest {@link Joint} ancestor of this component */
79
79
  Dest: Dest.bind(ctx2),
80
- /** Bound {@link Source} */
80
+ /** Puts its content inside of a {@link Dest} if it is available; There is no need to include this component on the DOM tree */
81
81
  Source: Source.bind(ctx2),
82
- /** Bound {@link Joint} */
82
+ /** Allows {@link Dest} and {@link Source} childrens to communicate with each other */
83
83
  Joint: Joint.bind(ctx2),
84
84
  /**
85
85
  * Gets an {@link Accessor} that tells if the context in which THIS getter has been executed has been extracted (Is inside of a {@link Dest})
package/dist/index.umd.js CHANGED
@@ -77,11 +77,11 @@
77
77
  name
78
78
  });
79
79
  return {
80
- /** Bound {@link Dest} */
80
+ /** Shows the content of the closest {@link Source} child of the closest {@link Joint} ancestor of this component */
81
81
  Dest: Dest.bind(ctx2),
82
- /** Bound {@link Source} */
82
+ /** Puts its content inside of a {@link Dest} if it is available; There is no need to include this component on the DOM tree */
83
83
  Source: Source.bind(ctx2),
84
- /** Bound {@link Joint} */
84
+ /** Allows {@link Dest} and {@link Source} childrens to communicate with each other */
85
85
  Joint: Joint.bind(ctx2),
86
86
  /**
87
87
  * Gets an {@link Accessor} that tells if the context in which THIS getter has been executed has been extracted (Is inside of a {@link Dest})
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "solid-ctrl-flow",
3
- "version": "1.0.17",
3
+ "version": "1.0.18",
4
4
  "description": "Control flow components for solid-js",
5
5
  "author": "AFatNiBBa",
6
6
  "license": "ISC",
package/readMe.md CHANGED
@@ -112,6 +112,14 @@ return <>
112
112
  21
113
113
  </>
114
114
  ```
115
+ Notice that you can use a `Source` component without adding it to the DOM:
116
+ ```tsx
117
+ <myCustomExtractor.Source>
118
+ {/* This doesn't get returned, but still gets shown if there is an available "Dest" */}
119
+ Something
120
+ </myCustomExtractor.Source>
121
+ return <>Something else</>
122
+ ```
115
123
 
116
124
  ## Utility functions
117
125
  Utility functions needed for the components above