close

Filter

loading table of contents...

Studio Developer Manual / Version 2204

Table Of Contents

9.16.3 Styling of Custom Studio Components

It is important to understand, that your skins are a reusable set of styles and should be applied to components whenever possible. This not only keeps maintenance easy, but also keeps your layout simple and clear. Nevertheless, there can be different reasons why you would want to write custom styles in addition to existing skins:

  • The component does not support skins

  • You are using a custom template inside a component

CoreMedia recommends placing your files in the same package in which the component is located. To do this, create a sencha/sass/ folder in the package's root folder. As long as the folder structure in your directories for TypeScript files and SCSS files match, the Sencha Microloader will find the SCSS files corresponding to the Ext JS components (as long a no custom namespace configuration is set in jangaroo.config.js).

Note

Note

You can write styles in any SCSS file that will be found by the Sencha Microloader. However, it is possible that styles and variables can be overridden in other SCSS files, due to the order these files get loaded. As a rule of thumb you can assume, that all SCSS files in sencha/var folders will be loaded prior files in sencha/src folders. Take a look at the Sencha Documentation to learn more about Organization of Generated Styles.

Own custom styles should be an exception and only be used if writing a new skin is not an option. While skin mixins provide a robust way to apply styles you can never be sure if your own CSS selectors will work after updating the framework or changing the layout of the parent container. You should especially avoid applying styles to the following CSS classes:

  • x-box-target

  • x-box-item

  • x-form-item

  • x-autocontainer-innerCt

  • x-autocontainer-outerCt

  • icon classes, such as cm-core-icons

  • all classes containing a scale or ui (such as x-btn-default-small)

The recommended way to apply styles to custom components and keep your CSS robust is to add own classes by using the cls configuration or the BEM Plugin (see Section 9.16.5, “Usage of BEM and Spacing Plugins”).

CoreMedia Studio defines own styles for custom components. If not needed, you can always disable these styles by setting the corresponding include variable to false.

Note

Note

SCSS files for custom components will be included after SCSS files in themes. This makes it impossible to override a custom component variable in the Blueprint Studio Theme. If you want to disable custom style rules, you will have to override the variable after the custom styles get included.

Search Results

Table Of Contents
warning

Your Internet Explorer is no longer supported.

Please use Mozilla Firefox, Google Chrome, or Microsoft Edge.