@compiled/react 0.10.0 → 0.10.1

package/src/class-names/index.tsx

@@ -1,4 +1,4 @@
-import type { ReactNode } from 'react';
+import type { ReactNode, CSSProperties } from 'react';
 
 import type { BasicTemplateInterpolations, CssFunction } from '../types';
 import { createSetupError } from '../utils/error';
@@ -8,36 +8,46 @@ export type Interpolations = (BasicTemplateInterpolations | CssFunction | CssFun
 export interface ClassNamesProps {
   children: (opts: {
     css: (css: CssFunction | CssFunction[], ...interpolations: Interpolations) => string;
-    style: { [key: string]: string };
+    style: CSSProperties;
   }) => ReactNode;
 }
 
 /**
- * Use a component where styles are not necessarily tied to an element.
+ * ## Class names
  *
+ * Use a component where styles are not necessarily used on a JSX element.
+ * For further details [read the documentation](https://compiledcssinjs.com/docs/api-class-names).
+ *
+ * ### Style with objects
+ *
+ * @example
  * ```
- * // Object CSS
  * <ClassNames>
  *   {({ css, style }) => children({ className: css({ fontSize: 12 }) })}
  * </ClassNames>
+ * ```
  *
- * // Template literal CSS
+ * ### Style with template literals
+ *
+ * @example
+ * ```
  * <ClassNames>
  *   {({ css, style }) => children({ className: css`font-size: 12px;` })}
  * </ClassNames>
+ * ```
  *
- * // Array CSS
+ * ### Compose styles with arrays
+ *
+ * @example
+ * ```
  * <ClassNames>
  *   {({ css, style }) =>
- *    children({ className: css([{ fontSize: 12 }, `font-size: 12px`]) })}
+ *    children({ className: css([{ fontSize: 12 }, css`font-size: 12px`]) })}
  * </ClassNames>
  * ```
- *
- * For more help, read the docs:
- * https://compiledcssinjs.com/docs/api-class-names
- *
- * @param props
  */
-export function ClassNames(_: ClassNamesProps): JSX.Element {
+export function ClassNames({ children }: ClassNamesProps): JSX.Element;
+
+export function ClassNames(_props: ClassNamesProps): JSX.Element {
   throw createSetupError();
 }

package/src/css/__tests__/index.test.tsx

@@ -29,6 +29,13 @@ describe('css prop', () => {
     expect(getByText('hello world')).toHaveCompiledCss('font-size', '13px');
   });
 
+  it('should create hover styles', () => {
+    const styles = css({ ':hover': { color: 'red' } });
+    const { getByText } = render(<div css={styles}>hello world</div>);
+
+    expect(getByText('hello world')).toHaveCompiledCss('color', 'red', { target: ':hover' });
+  });
+
   it('should create css from tagged template expression variable', () => {
     const style = css`
       font-size: 13px;

package/src/css/index.tsx

@@ -1,43 +1,51 @@
 /* eslint-disable import/export */
 
-import type { BasicTemplateInterpolations, CSSProps, FunctionInterpolation } from '../types';
+import type {
+  AnyKeyCssProps,
+  BasicTemplateInterpolations,
+  CSSProps,
+  FunctionInterpolation,
+} from '../types';
 import { createSetupError } from '../utils/error';
 
 /**
- * Create styles that can be re-used between components with a template literal.
+ * ## CSS
  *
+ * Define styles that are statically typed and useable with other Compiled APIs.
+ * For further details [read the documentation](https://compiledcssinjs.com/docs/api-css).
+ *
+ * ### Style with objects
+ *
+ * @example
  * ```
- * css`color: red;`;
+ * const redText = css({
+ *   color: 'red',
+ * });
+ *
+ * <div css={redText} />
  * ```
  *
- * For more help, read the docs:
- * https://compiledcssinjs.com/docs/api-css
+ * ### Style with template literals
  *
- * @param css
- * @param values
+ * @example
+ * ```
+ * const redText = css`
+ *   color: red;
+ * `;
+ *
+ * <div css={redText} />
+ * ```
  */
 export default function css<T = void>(
-  _css: TemplateStringsArray,
-  ..._values: (BasicTemplateInterpolations | FunctionInterpolation<T>)[]
+  styles: TemplateStringsArray,
+  ...interpolations: (BasicTemplateInterpolations | FunctionInterpolation<T>)[]
 ): CSSProps;
 
-/**
- * Create styles that can be re-used between components with an object
- *
- * ```
- * css({ color: 'red' });
- * ```
- *
- * For more help, read the docs:
- * https://compiledcssinjs.com/docs/api-css
- *
- * @param css
- */
-export default function css(_css: CSSProps): CSSProps;
+export default function css(styles: AnyKeyCssProps<void> | CSSProps): CSSProps;
 
 export default function css<T = void>(
-  _css: TemplateStringsArray | CSSProps,
-  ..._values: (BasicTemplateInterpolations | FunctionInterpolation<T>)[]
+  _styles: TemplateStringsArray | CSSProps,
+  ..._interpolations: (BasicTemplateInterpolations | FunctionInterpolation<T>)[]
 ): CSSProps {
   throw createSetupError();
 }

package/src/jsx/jsx-local-namespace.tsx

@@ -4,16 +4,42 @@ type WithConditionalCSSProp<TProps> = 'className' extends keyof TProps
   ? string extends TProps['className' & keyof TProps]
     ? {
         /**
-         * Tie styles to an element.
+         * ## CSS prop
          *
+         * Style a JSX element.
+         * For further details [read the API documentation](https://compiledcssinjs.com/docs/api-css-prop).
+         *
+         * ### Style with objects
+         *
+         * @example
+         * ```
+         * import { css } from '@compiled/react';
+         *
+         * <div css={css({ fontSize: 12 })} />
+         * ```
+         *
+         * ### Style with template literals
+         *
+         * @example
+         * ```
+         * import { css } from '@compiled/react';
+         *
+         * <div css={css`color: red;`} />
          * ```
-         * css={{ fontSize: 12 }} // Object CSS
-         * css={`font-size: 12px;`} // Template literal CSS
-         * css={[{ fontSize: 12 }, `font-size: 12px;`]} // Array CSS
+         *
+         * ### Compose styles with arrays
+         *
+         * @example
          * ```
+         * import { css } from '@compiled/react';
          *
-         * For more help, read the docs:
-         * https://compiledcssinjs.com/docs/api-css-prop
+         * <div
+         *  css={[
+         *    css({ fontSize: 12 }),
+         *    css`color: red;`,
+         *  ]}
+         * />
+         * ```
          */
         css?: CssFunction | CssFunction[];
       }

package/src/keyframes/index.tsx

@@ -4,28 +4,14 @@ import { createSetupError } from '../utils/error';
 export type KeyframeSteps = string | Record<string, CSSProps>;
 
 /**
- * Create keyframes using a tagged template expression:
+ * ## Keyframes
  *
- * ```
- * const fadeOut = keyframes`
- *   from { opacity: 1; }
- *   to   { opacity: 0; }
- * `;
- * ```
- *
- * @param _strings The input string values
- * @param _interpolations The arguments used in the expression
- */
-export function keyframes(
-  _strings: TemplateStringsArray,
-  ..._interpolations: BasicTemplateInterpolations[]
-): string;
-
-/**
- * Create keyframes using:
+ * Define keyframes to be used in a [CSS animation](https://developer.mozilla.org/en-US/docs/Web/CSS/animation).
+ * For further details [read the API documentation](https://compiledcssinjs.com/docs/api-keyframes).
  *
- * 1. An object expression
+ * ### Style with objects
  *
+ * @example
  * ```
  * const fadeOut = keyframes({
  *   from: {
@@ -35,23 +21,33 @@ export function keyframes(
  *     opacity: 0,
  *   },
  * });
+ *
+ * <div css={{ animation: `${fadeOut} 2s` }} />
  * ```
  *
- * 2. A string
+ * ### Style with template literals
  *
+ * @example
  * ```
- * const fadeOut = keyframes('from { opacity: 1; } to { opacity: 0; }');
- * ```
+ * const fadeOut = keyframes`
+ *   from {
+ *     opacity: 1;
+ *   }
  *
- * 3. A template literal
+ *   to {
+ *     opacity: 0;
+ *   }
+ * `;
  *
+ * <div css={{ animation: `${fadeOut} 2s` }} />
  * ```
- * const fadeOut = keyframes(`from { opacity: 1; } to { opacity: 0; }`);
- * ```
- *
- * @param _steps The waypoints along the animation sequence
  */
-export function keyframes(_steps: KeyframeSteps): string;
+export function keyframes(steps: KeyframeSteps): string;
+
+export function keyframes(
+  strings: TemplateStringsArray,
+  ...interpolations: BasicTemplateInterpolations[]
+): string;
 
 export function keyframes(
   _stringsOrSteps: TemplateStringsArray | KeyframeSteps,

package/src/styled/index.tsx

@@ -58,17 +58,45 @@ export interface StyledComponentInstantiator extends StyledComponentMap {
 }
 
 /**
- * Create a component that ties styles to an element which comes with built-in behavior such as `ref` and `as` prop support.
+ * ## Styled component
  *
+ * Create a component that styles a JSX element which comes with built-in behavior such as `ref` and `as` prop support.
+ * For further details [read the documentation](https://compiledcssinjs.com/docs/api-styled).
+ *
+ * ### Style with objects
+ *
+ * @example
+ * ```
+ * styled.div({
+ *   fontSize: 12,
+ * });
+ * ```
+ *
+ * ### Style with template literals
+ *
+ * @example
  * ```
- * styled.div`font-size: 12px`; // Template literal CSS
- * styled.div({ fontSize: 12 }); // Object CSS
- * styled.div([{ fontSize: 12 }, `font-size: 12px;`]) // Array CSS
- * styled.div({ fontSize: 12 }, `font-size: 12px`) Multi arguments CSS
+ * styled.div`
+ *   font-size: 12px
+ * `;
  * ```
  *
- * For more help, read the docs:
- * https://compiledcssinjs.com/docs/api-styled
+ * ### Compose styles with arrays
+ *
+ * @example
+ * ```
+ * import { css } from '@compiled/react';
+ *
+ * styled.div([
+ *   { fontSize: 12 },
+ *   css`font-size: 12px;`
+ * ]);
+ *
+ * styled.div(
+ *   { fontSize: 12 },
+ *   css`font-size: 12px`
+ * );
+ * ```
  */
 export const styled: StyledComponentInstantiator = new Proxy(
   {},

package/CHANGELOG.md

@@ -1,128 +0,0 @@
-# @compiled/react
-
-## 0.10.0
-
-### Minor Changes
-
-- 427cead: **Breaking change:** When using the `css` prop with [TypeScript](https://www.typescriptlang.org) you now need to declare a JSX pragma enabling types for that module. Previously when importing the `@compiled/react` package the global JSX namespace would be polluted as a side effect potentially causing collisions with other CSS-in-JS libraries. Now thanks to the use of [locally scoped JSX namespaces](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-8.html#locally-scoped-jsx-namespaces) the global JSX namespace will no longer be polluted.
-
-  As an added bonus the `css` prop will only be available on JSX elements that have also defined a `className` prop with the potential for more type safe features later on.
-
-  Make sure to update all Compiled dependencies to latest when adopting this change.
-
-  **Automatic runtime**
-
-  ```diff
-  -import '@compiled/react';
-  +/** @jsxImportSource @compiled/react */
-
-  <div css={{ display: 'block' }} />;
-  ```
-
-  **Classic runtime**
-
-  ```diff
-  -import '@compiled/react';
-  +/** @jsx jsx */
-  +import { jsx } from '@compiled/react';
-
-  <div css={{ display: 'block' }} />;
-  ```
-
-  To aid consumers in adopting this change easily, a new ESLint rule `jsx-pragma` has been created which will automatically migrate you to use a JSX pragma if missing when running with `--fix`. The rule takes an option to configure the runtime (either classic or automatic) and defaults to automatic.
-
-  ```sh
-  npm i @compiled/eslint-plugin
-  ```
-
-  ```json
-  {
-    "rules": {
-      "@compiled/jsx-pragma": ["error", { "runtime": "classic" }]
-    }
-  }
-  ```
-
-### Patch Changes
-
-- 79cfb08: Internal refactor changing how the TypeScript compiler picks up source files.
-
-## 0.9.1
-
-### Patch Changes
-
-- 4309aaa: Patch inexact flow type on styled
-
-## 0.9.0
-
-### Minor Changes
-
-- 2092839: Allow inline strings and inline css mixins in conditional expressions. Fix ordering of styles in template literals.
-
-## 0.8.0
-
-### Minor Changes
-
-- 4210ff6: Add flow types support
-- 53935b3: Add `ObjectExpression` support to `css`
-
-## 0.7.0
-
-### Minor Changes
-
-- bcb2a68: Add support for `keyframes`
-- a7ab8e1: Add support for conditional rules for `Styled`
-
-## 0.6.13
-
-### Patch Changes
-
-- 13c3a60: add support of additional parameters to css function
-
-## 0.6.12
-
-### Patch Changes
-
-- b5b4e8a: Catch unhandled exception on inserting rules with prefixed selectors.
-
-## 0.6.11
-
-### Patch Changes
-
-- ee3363e: Fix HTML characters escapes in style tags on SSR.
-
-## 0.6.10
-
-### Patch Changes
-
-- 40bc0d9: Package descriptions have been updated.
-- 1b1c964: The `css` mixin API is now available,
-  functioning similarly to the [emotion equivalent](https://emotion.sh/docs/composition).
-
-  ```jsx
-  import { css } from '@compiled/react';
-
-  <div
-    css={css`
-      display: flex;
-      font-size: 50px;
-      color: blue;
-    `}
-  >
-    blue text
-  </div>;
-  ```
-
-  For more help, read the docs: https://compiledcssinjs.com/docs/css.
-
-## 0.6.9
-
-### Patch Changes
-
-- 4032cd4: Memo has been removed from the style component which was breaking re-renders at times.
-
-## 0.6.8
-
-### Patch Changes
-
-- aea3504: Packages now released with [changesets](https://github.com/atlassian/changesets).