Skip to content

Latest commit

 

History

History
78 lines (56 loc) · 3.61 KB

README.adoc

File metadata and controls

78 lines (56 loc) · 3.61 KB
Raw

logo

fulcro CircleCI

Fulcro is a library for building data-driven full-stack applications for the web, native, and desktop (via electron). It uses React and is written in Clojure and Clojurescript.

1. Fulcro 3.6, and React 18 Notes

React 18 finally made changes that required some (minor) breaking changes to Fulcro. The support for async rendering in version 18 meant that we could no longer rely on dynamic vars in the internals (React 15 had no other way to do it).

As a result, some (hopefully never or rarely-used) features are deprecated or slightly modified:

  • The dynamic vars *app*, *parent*, *shared*, *depth*, and *blindly-render?* should not be used. An attempt was made to make most of them continue to work.

  • The 0-arity version of comp/current-state is no longer available. Pass this to it instead.

  • The 0-arity version of comp/shared is no longer available. Pass this or app to it instead.

  • Custom renderers (if you wrote one yourself) MUST now set a React context. See keyframe-renderer for details.

  • *query-state* still exists, but is for internal use only, and cannot be trusted within render. Pass app state to calls to get-query if you’re using dynamic queries.

Using full React 18 requires that you wrap your app with a version helper:

(ns example.app
    (:require
      [com.fulcrologic.fulcro.react.version18 :refer [with-react18]]
      [com.fulcrologic.fulcro.application :as app]
      ...)

(def app (with-react18 (app/fulcro-app {})))

2. Trying it Out

The documentation for this version is in the Developer’s Guide. If you’re using Fulcro 2, you can still read the prior version of the guide.

There is also a template project which you can use as a starting point.

Finally, there is a plenty of great resources collected at the Fulcro Community site.

3. Contributing to Fulcro

For learning more about how to contribute to the Fulcro project, please refer CONTRIBUTING.md

4. Copyright and License

Fulcro is:

Copyright (c) 2017-2022, Fulcrologic, LLC The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.