https://github.com/astrada/ppx_bs_css

A ppx rewriter for CSS expressions.
https://github.com/astrada/ppx_bs_css

css ocaml ppx reasonml

Last synced: about 2 months ago
JSON representation

A ppx rewriter for CSS expressions.

• Host: GitHub
• URL: https://github.com/astrada/ppx_bs_css
• Owner: astrada
• License: mit
• Archived: true
• Created: 2018-02-22T20:42:11.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-02-11T08:20:35.000Z (over 2 years ago)
• Last Synced: 2024-02-04T17:31:00.619Z (5 months ago)
• Topics: css, ocaml, ppx, reasonml
• Language: OCaml
• Size: 365 KB
• Stars: 98
• Watchers: 4
• Forks: 8
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-list - ppx_bs_css
• awesome-ppx-reasonml - ppx_bs_css - A ppx rewriter for CSS expressions. (PPXs)

README

        
ppx\_bs\_css

============

A ppx rewriter for CSS expressions.

Parses a CSS string and produces a declaration block compatible with

[bs-css](https://github.com/SentiaAnalytics/bs-css), and

[typed-css-core](https://github.com/glennsl/bs-typed-css/tree/master/packages/core).

### Quick start

```

yarn add -D ppx_bs_css

```

or 

```

npm i -D ppx_bs_css

```

### Usage

Add the PPX to your `bsconfig.json`:

```json

{

    "ppx-flags": [

        "ppx_bs_css/ppx"

    ]

}

```

### Examples

Basic `bs-css` rules (ReasonML syntax):

```reason

/* rules has type list(Css.rule) */

let rules =

  let open Css;

  [%style

    {|

      color: red;

      background-color: white;

      margin: auto 0 10px 1em;

      border-bottom: thin dashed #eee;

      border-right-color: rgb(1, 0, 1);

      width: 70%;

      background: url(http://example.com/test.jpg)

    |}

  ];

```

`bs-css` rules with selectors (ReasonML syntax):

```reason

/* rules has type list(Css.rule) */

let css =

  let open Css;

  [%css

    {|

      {

        color: red;

      }

      :hover {

        color: blue;

      }

    |}

  ];

```

`bs-css` keyframes (ReasonML syntax):

```reason

let bounces =

  let open Css;

  [%style

    {|

      @keyframes {

        from { transform: scale(0.1, 0.1); opacity: 0.0; }

        60% { transform: scale(1.2, 1.2); opacity: 1.0; }

        to { transform: scale(1.0, 1.0); opacity: 1.0; }

      }

    |}

  ];

let bounce = List.hd(bounces);

let stylesWithAnimation =

  let open Css;

  [%style

    {|

      animation-name: bounce;

      animation-duration: 2000;

      width: 50px;

      height: 50px;

      background-color: rgb(255, 0, 0)

    |}

  ];

```

Basic `typed-glamor` declaration block (ReasonML syntax):

```reason

/* declarations has type list(TypedGlamor.Core.declaration) */

let declarations =

  let open TypedGlamor;

  [%style

    {typed|

      color: red;

      background-color: white;

      margin: auto 0 10px 1em;

      border-bottom: thin dashed #eee;

      border-right-color: rgb(1, 0, 1);

      width: 70%;

      background: url(http://example.com/test.jpg)

    |typed}

  ];

```

Selectors also work with `typed-glamor`. They need the `[%css]` extension instead of `[%style]`:

```reason

/* Selectors */

let _ = {

  let open TypedGlamor;

  [%css

    {typed|

      {

        color: red;

      }

      :hover {

        color: blue;

      }

    |typed}

  ];

};

```

See also:

[ppx_bs_css-examples](https://github.com/astrada/ppx_bs_css-examples).

### What you get

* Errors at compile time:

![Color typo](doc/color_typo.png)

* Merlin support:

![Merlin type error](doc/merlin_type_error.png)

![Merlin function info](doc/merlin_function.png)

### What you don't get

* Autocomplete

### Development

    npm install -g esy

    esy

    # to build test_bs

    cd test_bs && yarn install

    # to run test_bs

    yarn build

### Supported versions

* `ppx_bs_css` version 0.1.0 supports `bs-css` v7

* `ppx_bs_css` version 0.2.0 supports `bs-css` v10