feat: release v1

dash-ui · Jun 25, 2022 · 3c3e40a · 3c3e40a
2 parents 256430c + 74520ab
commit 3c3e40a
Show file tree

Hide file tree

Showing 16 changed files with 2,316 additions and 1,629 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,19 @@
+# [1.0.0-alpha.2](https://github.com/dash-ui/react-layout/compare/v1.0.0-alpha.1...v1.0.0-alpha.2) (2022-06-25)
+
+### Features
+
+- remove alpha peers ([b5e8dd5](https://github.com/dash-ui/react-layout/commit/b5e8dd5697f23887cc66cc6b9cfd16ea284aa2da))
+
+# [1.0.0-alpha.1](https://github.com/dash-ui/react-layout/compare/v0.9.3...v1.0.0-alpha.1) (2021-10-29)
+
+### Features
+
+- update types and apis to support latest dash alpha ([a75301d](https://github.com/dash-ui/react-layout/commit/a75301d9047ba79ec7b9a46e30848717055581e8))
+
+### BREAKING CHANGES
+
+- Types and expected input styles instance are updated to the latest alpha
+
 ## [0.9.3](https://github.com/dash-ui/react-layout/compare/v0.9.2...v0.9.3) (2021-10-03)
 
 ### Bug Fixes

diff --git a/README.md b/README.md
@@ -118,7 +118,7 @@ const Component = () => (
 
 | Component                             | Description                                                                                                            |
 | ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
-| [`<LayoutProvider>`](#layoutprovider) | A context provider which is only required if you intend on using responsive props or a custom `styles()` instance.     |
+| [`<LayoutProvider>`](#layoutprovider) | A context provider which is only required if you intend on using responsive props or a custom `styles` instance.       |
 | [`<Box>`](#box)                       | A layout component for adding size, padding, position, color, and more using tokens from your CSS variable theme.      |
 | [`<Cluster>`](#cluster)               | A row directional layout component that distributes its items in a cluster. Common use cases are tags and input chips. |
 | [`<Column>`](#column)                 | A layout component that distributes its items in a column without wrapping or shrinking.                               |
@@ -131,9 +131,9 @@ const Component = () => (
 
 ### Hooks
 
-| Component                                       | Description                                                                                                           |
-| ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
-| [`useResponsiveStyles()`](#useresponsivestyles) | Returns the [responsive `styles()`](https://github.com/dash-ui/responsive) used for creating responsive layout props. |
+| Component                                       | Description                                                                                                         |
+| ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
+| [`useResponsiveStyles()`](#useresponsivestyles) | Returns the [responsive `styles`](https://github.com/dash-ui/responsive) used for creating responsive layout props. |
 
 ### TypeScript support
 
@@ -153,7 +153,7 @@ components.
 ### &lt;LayoutProvider&gt;
 
 A context provider which is only required if you intend on using media query
-props or a custom `styles()` instance.
+props or a custom `styles` instance.
 
 #### Example
 
@@ -191,10 +191,10 @@ const Component = () => (
 
 #### Props
 
-| Prop         | Type                                 | Default  | Required? | Description                                                                                                                                                            |
-| ------------ | ------------------------------------ | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| styles       | `Styles<DashTokens, DashThemeNames>` | `styles` | No        | The `styles()` instance you're using to create styles. By default this is the `styles()` instance exported from [`@dash-ui/styles`](https://github.com/dash-ui/styles) |
-| mediaQueries | `Record<string, string>`             |          | No        | A mapping of name/media query pairs. This is only required if youre' using responsive props.                                                                           |
+| Prop         | Type                             | Default  | Required? | Description                                                                                                                                                        |
+| ------------ | -------------------------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| styles       | `Styles<DashTokens, DashThemes>` | `styles` | No        | The `styles` instance you're using to create styles. By default this is the `styles` instance exported from [`@dash-ui/styles`](https://github.com/dash-ui/styles) |
+| mediaQueries | `Record<string, string>`         |          | No        | A mapping of name/media query pairs. This is only required if youre' using responsive props.                                                                       |
 
 ### &lt;Box&gt;
 
@@ -559,7 +559,7 @@ const Component = () => (
 
 ### useResponsiveStyles()
 
-Returns the [responsive `styles()`](https://github.com/dash-ui/responsive)
+Returns the [responsive `styles`](https://github.com/dash-ui/responsive)
 used for creating responsive layout props.
 
 #### Returns

diff --git a/package.json b/package.json
@@ -1,52 +1,14 @@
 {
   "name": "@dash-ui/react-layout",
-  "version": "0.9.3",
+  "version": "1.0.0-alpha.2",
   "description": "Awesome layout primitives for React using @dash-ui",
-  "keywords": [
-    "react",
-    "react component",
-    "react layout",
-    "layout components",
-    "dash layout components",
-    "dash-ui layout components",
-    "react layout components",
-    "stack component",
-    "grid component",
-    "cluster component",
-    "layer component",
-    "react stack component",
-    "react grid component",
-    "react cluster component",
-    "react layer component",
-    "spacing component",
-    "spacer component",
-    "react spacing component",
-    "css-in-react layout"
-  ],
-  "homepage": "https://github.com/dash-ui/react-layout#readme",
-  "bugs": "https://github.com/dash-ui/react-layout/issues",
-  "repository": "github:dash-ui/react-layout",
   "license": "MIT",
   "author": "Jared Lunde <jared.lunde@gmail.com> (https://jaredlunde.com/)",
-  "sideEffects": false,
-  "exports": {
-    ".": {
-      "browser": "./dist/module/index.js",
-      "import": "./dist/esm/index.mjs",
-      "require": "./dist/main/index.js",
-      "umd": "./dist/umd/dash-react-layout.js",
-      "source": "./src/index.tsx",
-      "types": "./types/index.d.ts",
-      "default": "./dist/main/index.js"
-    },
-    "./package.json": "./package.json",
-    "./": "./"
-  },
+  "homepage": "https://github.com/dash-ui/react-layout#readme",
+  "repository": "github:dash-ui/react-layout",
+  "bugs": "https://github.com/dash-ui/react-layout/issues",
   "main": "dist/main/index.js",
-  "unpkg": "dist/umd/dash-react-layout.js",
   "module": "dist/module/index.js",
-  "source": "src/index.tsx",
-  "types": "types/index.d.ts",
   "files": [
     "/dist",
     "/src",
@@ -62,25 +24,77 @@
     "test": "jest",
     "validate": "lundle check-types && pnpm run lint && jest --coverage"
   },
-  "commitlint": {
-    "extends": [
-      "@commitlint/config-conventional"
-    ]
-  },
-  "lint-staged": {
-    "**/*.{ts,tsx,js,jsx}": [
-      "eslint --ext .ts,.tsx,.js,.jsx --fix",
-      "prettier --write"
-    ],
-    "**/*.{md,yml,json}": [
-      "prettier --write"
-    ]
-  },
   "config": {
     "commitizen": {
       "path": "./node_modules/cz-conventional-changelog"
     }
   },
+  "sideEffects": false,
+  "types": "types/index.d.ts",
+  "dependencies": {
+    "@dash-ui/responsive": "^1.0.0-alpha.1",
+    "clsx": "^1.1.1",
+    "forward-ref-as": "^2.0.0"
+  },
+  "peerDependencies": {
+    "@dash-ui/styles": ">=1.0.1",
+    "react": ">=16.8"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "latest",
+    "@commitlint/config-conventional": "latest",
+    "@dash-ui/jest": "^2.1.2",
+    "@dash-ui/styles": "^1.0.1",
+    "@semantic-release/changelog": "^6.0.0",
+    "@semantic-release/git": "^10.0.0",
+    "@testing-library/jest-dom": "latest",
+    "@testing-library/react": "latest",
+    "@testing-library/react-hooks": "latest",
+    "@testing-library/user-event": "latest",
+    "@types/jest": "latest",
+    "@types/node": "^18.0.0",
+    "@types/react": "latest",
+    "@types/react-dom": "latest",
+    "cz-conventional-changelog": "latest",
+    "eslint": "^7.32.0",
+    "eslint-config-lunde": "latest",
+    "husky": "latest",
+    "jest": "27",
+    "lint-staged": "latest",
+    "lundle": "^0.4.13",
+    "minify-css.macro": "^1.0.6",
+    "prettier": "latest",
+    "react": "latest",
+    "react-dom": "latest",
+    "react-test-renderer": "latest",
+    "typescript": "latest"
+  },
+  "keywords": [
+    "cluster component",
+    "css-in-react layout",
+    "dash layout components",
+    "dash-ui layout components",
+    "grid component",
+    "layer component",
+    "layout components",
+    "react",
+    "react cluster component",
+    "react component",
+    "react grid component",
+    "react layer component",
+    "react layout",
+    "react layout components",
+    "react spacing component",
+    "react stack component",
+    "spacer component",
+    "spacing component",
+    "stack component"
+  ],
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
   "eslintConfig": {
     "extends": [
       "lunde"
@@ -115,6 +129,19 @@
     "/types",
     "*.config.js"
   ],
+  "exports": {
+    ".": {
+      "browser": "./dist/module/index.js",
+      "import": "./dist/esm/index.mjs",
+      "require": "./dist/main/index.js",
+      "umd": "./dist/umd/dash-react-layout.js",
+      "source": "./src/index.tsx",
+      "types": "./types/index.d.ts",
+      "default": "./dist/main/index.js"
+    },
+    "./package.json": "./package.json",
+    "./": "./"
+  },
   "jest": {
     "collectCoverageFrom": [
       "**/src/**/*.{ts,tsx}"
@@ -142,48 +169,29 @@
       "<rootDir>/src/**/?(*.)test.{ts,tsx}"
     ]
   },
-  "devDependencies": {
-    "@commitlint/cli": "latest",
-    "@commitlint/config-conventional": "latest",
-    "@dash-ui/jest": "^2.1.2",
-    "@dash-ui/styles": "^0.8.6",
-    "@semantic-release/changelog": "^6.0.0",
-    "@semantic-release/git": "^10.0.0",
-    "@testing-library/jest-dom": "latest",
-    "@testing-library/react": "latest",
-    "@testing-library/react-hooks": "latest",
-    "@testing-library/user-event": "latest",
-    "@types/jest": "latest",
-    "@types/react": "latest",
-    "@types/react-dom": "latest",
-    "cz-conventional-changelog": "latest",
-    "eslint": "latest",
-    "eslint-config-lunde": "latest",
-    "husky": "latest",
-    "jest": "latest",
-    "lint-staged": "latest",
-    "lundle": "^0.4.13",
-    "minify-css.macro": "^1.0.6",
-    "prettier": "latest",
-    "react": "latest",
-    "react-dom": "latest",
-    "react-test-renderer": "latest",
-    "typescript": "latest"
-  },
-  "dependencies": {
-    "@dash-ui/responsive": "^0.2.3",
-    "clsx": "^1.1.1",
-    "forward-ref-as": "^2.0.0"
-  },
-  "peerDependencies": {
-    "@dash-ui/styles": ">=0.8.4",
-    "react": ">=16.8"
+  "lint-staged": {
+    "package.json": [
+      "pnpm dlx prettier-package-json --write"
+    ],
+    "**/*.{ts,tsx,js,jsx}": [
+      "eslint --ext .ts,.tsx,.js,.jsx --fix",
+      "prettier --write"
+    ],
+    "**/*.{md,yml,json}": [
+      "prettier --write"
+    ]
   },
   "release": {
     "branches": [
       "main",
-      "next",
-      "alpha"
+      {
+        "name": "next",
+        "prerelease": true
+      },
+      {
+        "name": "alpha",
+        "prerelease": true
+      }
     ],
     "plugins": [
       "@semantic-release/commit-analyzer",
@@ -203,5 +211,7 @@
       ],
       "@semantic-release/github"
     ]
-  }
+  },
+  "source": "src/index.tsx",
+  "unpkg": "dist/umd/dash-react-layout.js"
 }