@salty-css/core 0.0.1-alpha.0

package/README.md

@@ -0,0 +1,107 @@
+# Salty Css
+
+## Basic usage example with Button
+
+### Initial requirements
+
+1. Add `saltyPlugin` to vite or webpack config from `@salty-css/vite` or `@salty-css/webpack`
+2. Create `salty-config.ts` to the root of your project
+3. Import global styles to any regular .css file from `saltygen/index.css` (does not exist during first run, cli command coming later)
+4. Create salty components with styled only inside files that end with `.css.ts`, `.salty.ts` `.styled.ts` or `.styles.ts`
+
+### Code examples
+
+**Salty config**
+
+```tsx
+import { defineConfig } from '@salty-css/core/config';
+
+export const config = defineConfig({
+  variables: {
+    colors: {
+      brand: '#111',
+      highlight: 'yellow',
+    },
+  },
+  global: {
+    html: {
+      backgroundColor: '#f8f8f8',
+    },
+  },
+});
+```
+
+**Your React component file**
+
+```tsx
+import { Wrapper } from '../components/wrapper/wrapper.css';
+import { Button } from '../components/button/button.css';
+
+export const IndexPage = () => {
+  return (
+    <Wrapper>
+      <Button variant="solid" onClick={() => alert('It is a button.')}>
+        Outlined
+      </Button>
+    </Wrapper>
+  );
+};
+```
+
+**Wrapper** (`components/wrapper/wrapper.css.ts`)
+
+```tsx
+import { styled } from '@salty-css/react/styled';
+
+export const Wrapper = styled('div', {
+  display: 'block',
+  padding: '2vw',
+});
+```
+
+**Button** (`components/button/button.css.ts`)
+
+```tsx
+import { styled } from '@salty-css/react/styled';
+
+export const Button = styled('button', {
+  display: 'block',
+  padding: `0.6em 1.2em`,
+  border: '1px solid currentColor',
+  background: 'transparent',
+  color: 'currentColor/40',
+  cursor: 'pointer',
+  transition: '200ms',
+  textDecoration: 'none',
+  '&:hover': {
+    background: 'black',
+    borderColor: 'black',
+    color: 'white',
+  },
+  '&:disabled': {
+    opacity: 0.25,
+    pointerEvents: 'none',
+  },
+  variants: {
+    variant: {
+      outlined: {
+        // same as default styles
+      },
+      solid: {
+        '&:not(:hover)': {
+          background: 'black',
+          borderColor: 'black',
+          color: 'white',
+        },
+        '&:hover': {
+          background: 'transparent',
+          borderColor: 'currentColor',
+          color: 'currentColor',
+        },
+      },
+    },
+  },
+});
+```
+
+More examples coming soon

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@salty-css/core",
+  "version": "0.0.1-alpha.0",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "typings": "./dist/index.d.ts",
+  "type": "module",
+  "license": "MIT",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://github.com/margarita-form/salty-css",
+  "bugs": {
+    "url": "https://github.com/margarita-form/salty-css/issues"
+  },
+  "files": [
+    "dist",
+    "!**/*.tsbuildinfo"
+  ],
+  "nx": {
+    "name": "core"
+  },
+  "exports": {
+    ".": {
+      "import": "./index.js",
+      "require": "./index.cjs"
+    },
+    "./react/styled": {
+      "import": "./react/styled.js",
+      "require": "./react/styled.cjs"
+    },
+    "./react/styled-client": {
+      "import": "./react/styled-client.js",
+      "require": "./react/styled-client.cjs"
+    },
+    "./react/css-helpers": {
+      "import": "./react/css-helpers.js",
+      "require": "./react/css-helpers.cjs"
+    },
+    "./vite": {
+      "import": "./vite/index.js",
+      "require": "./vite/index.cjs"
+    },
+    "./webpack/salty-loader": {
+      "import": "./webpack/salty-loader.js",
+      "require": "./webpack/salty-loader.cjs"
+    }
+  }
+}