#################################
Django cradmin 3.0.0 releasenotes
#################################


.. note::

    This release marks the end of long lasting major releases.
    From now on we will release a major release when adding
    anything major, or when introducing any changes that require
    some kind of manual or dangerous update of existing projects.



*********
Whats new
*********
- Add a new set of icon mixins and standard icons. Font-awesome is
  implemented as the default, but adding other icon sets is fairly
  easy. This is documented in :doc:`../theme`.
- Update the javascript with the new icon css classes.

.. note:: There is no changes to the Python code, only so the theme .scss and javascript files.


***********************
Migrate from 2.x to 3.x
***********************

Update .scss files
==================

After updating to 3.x, your custom themes will break. You will need to update
so that you include ``@import 'basetheme/3__base/cricon/cricon-font-awesome';`` before
``@import 'basetheme/3__base/all';``.

So if you had the following with cradmin 2.x:

.. code-block:: scss

    @import 'basetheme/1__settings/all';
    @import '1__settings/all';

    @import 'basetheme/2__generic/all';
    @import '2__generic/all';

    @import 'basetheme/3__base/all';
    @import '3__base/all';

    @import 'basetheme/4__components/all';
    @import '4__components/all';


You will have the following with 3.x+:

.. code-block:: scss

    @import 'autogenerated_partials/variables';
    @import 'basetheme/1__settings/all';
    @import '1__settings/all';

    @import 'basetheme/2__generic/all';
    @import '2__generic/all';

    @import 'basetheme/3__base/cricon/cricon-font-awesome';  // This line is new!
    @import 'basetheme/3__base/all';
    @import '3__base/all';

    @import 'basetheme/4__components/all';
    @import '4__components/all';


Furthermore, if you have a custom ``$font-size`` variable you need to ensure you have
all the required sizes in the map:

- xxsmall
- xsmall
- small
- medium
- large
- xlarge
- xxlarge
- xxxlarge
- smallcaps


Update javascript
=================
You need to update your package.json to have `"django_cradmin_js": "^3.0.0"` as a requirement.