Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc #133

Merged
merged 3 commits into from
Jan 15, 2024
Merged

Doc #133

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
- [Helux-nextjs-starter](https://github.com/heluxjs/helux-nextjs-starter)

It has the following features:

- Developed based on the fastest immutable js library [limu](https://github.com/tnfe/limu), with super performance
- Atom supports dependency collection, which means that atom does not need to be split into details. Atom can be equivalent to model, which is naturally friendly to `DDD` domain-driven design.
- Built-in signal response mechanism, which can achieve 0 hook encoding + DOM granular update
Expand Down
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,5 +215,3 @@ watch(
小小鼓励,给予我们更多力量坚持做出更好的开源项目

<img width="830" alt="image" src="https://github.com/heluxjs/helux/assets/7334950/657c2d0d-36cc-4f9c-9869-7313b0a7825f">


2 changes: 1 addition & 1 deletion docs/docs/playground/demos/Playground/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export default () => {
const { name } = info;
cachedSubNames[name] = subName;
setInfo({ name, subName, code: getCode(name, subName) });
}
};

return (
<LiveProvider noInline={true} code={info.code} scope={scope} theme={prism.themes.vsDark}>
Expand Down
2 changes: 1 addition & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
"animated-scroll-to": "^2.3.0",
"classnames": "^2.5.0",
"console-feed": "^3.5.0",
"helux": "4.1.5",
"helux": "4.1.6",
"lodash": "^4.17.21",
"lodash.throttle": "^4.1.1",
"prism-react-renderer": "^2.3.1",
Expand Down
9 changes: 9 additions & 0 deletions packages/helux-core/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# @helux/core

## 4.1.6

### Patch Changes

- a73b4e3: build(4.1.6): add isDraft
- @helux/hooks-impl@4.1.6
- @helux/types@4.1.6
- @helux/utils@4.1.6

## 4.1.5

### Patch Changes
Expand Down
2 changes: 1 addition & 1 deletion packages/helux-core/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@helux/core",
"version": "4.1.5",
"version": "4.1.6",
"description": "A reactive atomic state engine for React like.",
"bugs": {
"url": "https://github.com/heluxjs/helux/issues"
Expand Down
3 changes: 2 additions & 1 deletion packages/helux-core/src/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ import {
} from './hooks';
import { block, dynamicBlock, signal } from './signal';

const { shallowCompare, isDiff } = limuUtils;
const { shallowCompare, isDiff, isDraft } = limuUtils;
const createShared = share; // for compatible wit v2 helux
const $ = signal; // signal api alias

Expand Down Expand Up @@ -111,6 +111,7 @@ export {
isDerivedResult,
isDiff,
isSharedState,
isDraft,
shallowCompare,
markRaw,
storeSrv,
Expand Down
2 changes: 1 addition & 1 deletion packages/helux-core/src/consts/user.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { VER as limuVer } from 'limu';

export const VER = '4.1.5';
export const VER = '4.1.6';

export const LIMU_VER = limuVer;

Expand Down
9 changes: 7 additions & 2 deletions packages/helux-core/src/types/api.d.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
|------------------------------------------------------------------------------------------------
| helux-core@4.1.5
| helux-core@4.1.6
| A state library core that integrates atom, signal, collection dep, derive and watch,
| it supports all react like frameworks ( including react 18 ).
|------------------------------------------------------------------------------------------------
Expand Down Expand Up @@ -68,7 +68,7 @@ import type {
} from './base';

export declare const cst: {
VER: '4.1.5';
VER: '4.1.6';
LIMU_VER: string;
EVENT_NAME: {
/** 共享状态创建时的事件 */
Expand Down Expand Up @@ -747,6 +747,11 @@ interface IProduce {
*/
export declare function isDiff(val1: any, val2: any): boolean;

/**
* 来自 LimuUtils.isDraft,判断是否是草稿节点
*/
export declare function isDraft(mayDraft: any): boolean;

export declare const produce: IProduce;

/**
Expand Down
2 changes: 1 addition & 1 deletion packages/helux-demo-utils/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"dependencies": {
"@types/react": ">=16.0.0",
"@types/react-dom": ">=16.0.0",
"helux": "^4.1.5",
"helux": "^4.1.6",
"react": ">=16.10.2",
"react-dom": ">=16.10.2"
},
Expand Down
7 changes: 7 additions & 0 deletions packages/helux-hooks-impl/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# @helux/hooks-impl

## 4.1.6

### Patch Changes

- @helux/types@4.1.6
- @helux/utils@4.1.6

## 4.1.5

### Patch Changes
Expand Down
2 changes: 1 addition & 1 deletion packages/helux-hooks-impl/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@helux/hooks-impl",
"version": "4.1.5",
"version": "4.1.6",
"description": "helux hooks implement lib",
"bugs": {
"url": "https://github.com/heluxjs/helux/issues"
Expand Down
8 changes: 8 additions & 0 deletions packages/helux-hooks/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# @helux/hooks

## 4.1.6

### Patch Changes

- @helux/hooks-impl@4.1.6
- @helux/types@4.1.6
- @helux/utils@4.1.6

## 4.1.5

### Patch Changes
Expand Down
2 changes: 1 addition & 1 deletion packages/helux-hooks/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@helux/hooks",
"version": "4.1.5",
"version": "4.1.6",
"description": "helux hooks lib for react",
"keywords": [
"helux",
Expand Down
8 changes: 8 additions & 0 deletions packages/helux-openinula/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# @helux/openinula

## 4.1.6

### Patch Changes

- a73b4e3: build(4.1.6): add isDraft
- Updated dependencies [a73b4e3]
- @helux/core@4.1.6

## 4.1.5

### Patch Changes
Expand Down
2 changes: 1 addition & 1 deletion packages/helux-openinula/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@helux/openinula",
"version": "4.1.5",
"version": "4.1.6",
"description": "State library for preact that integrates atom, signal, collection dep, derive and watch.",
"bugs": {
"url": "https://github.com/heluxjs/helux/issues"
Expand Down
1 change: 1 addition & 0 deletions packages/helux-openinula/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ export const {
isSharedState,
isDerivedAtom,
isDerivedResult,
isDraft,
storeSrv,
shallowCompare,
markRaw,
Expand Down
2 changes: 2 additions & 0 deletions packages/helux-types/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# @helux/types

## 4.1.6

## 4.1.5

## 4.1.4
Expand Down
2 changes: 1 addition & 1 deletion packages/helux-types/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@helux/types",
"version": "4.1.5",
"version": "4.1.6",
"description": "helux common types lib",
"keywords": [
"helux",
Expand Down
6 changes: 6 additions & 0 deletions packages/helux-utils/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# @helux/utils

## 4.1.6

### Patch Changes

- @helux/types@4.1.6

## 4.1.5

### Patch Changes
Expand Down
2 changes: 1 addition & 1 deletion packages/helux-utils/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@helux/utils",
"version": "4.1.5",
"version": "4.1.6",
"description": "helux utils lib",
"keywords": [
"helux",
Expand Down
8 changes: 8 additions & 0 deletions packages/helux/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# helux

## 4.1.6

### Patch Changes

- a73b4e3: build(4.1.6): add isDraft
- Updated dependencies [a73b4e3]
- @helux/core@4.1.6

## 4.1.5

### Patch Changes
Expand Down
2 changes: 1 addition & 1 deletion packages/helux/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "helux",
"version": "4.1.5",
"version": "4.1.6",
"description": "A reactive atomic state engine for React( including React 18).",
"bugs": {
"url": "https://github.com/heluxjs/helux/issues"
Expand Down
1 change: 1 addition & 0 deletions packages/helux/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ export const {
isSharedState,
isDerivedAtom,
isDerivedResult,
isDraft,
storeSrv,
shallowCompare,
markRaw,
Expand Down
5 changes: 3 additions & 2 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.