Native styled text

Category: Widgets
Subcategory: Mobile

Overview

Text which allows parts to be styled separately, allowing the text to break naturally at the end of the container.

Documentation

Demo url

NativeStyledText

One text which allows parts to be styled separately. This will allow for the text to break naturally at the end of the container.

You can of course in Mendix place multiple text widgets after each other. However, if the content does not fit, one or more entire text widgets will go to the next line, probably causing unnatural line breaks.

Features

  • Specify multiple texts
  • Optionally style each text
  • Optionally limit the text to a specified number of lines

Usage

  • Place the widget on the page
  • Add the texts you want to display.
  • For each text you can enter the name of the class to add to the text
  • Each text inherits the default.
  • Create the custom class in your theme.

Custom style class

You must create custom style classes for the widget to work correctly. (The widget cannot access the app theme so the app theme should overrule the widget default style.)

If the style classes are not created or are incorrect the widget will render all text in green.

The content below is an example.

The first export defines a default for all NativeStyledText widget instances.

The second export is an example that defines a nameStyle and an appointmentTime style. These names can be used as text class for the text items on the widget. The nextAppointmentStyledText should be placed as class on the widget. This an example only, you can define as many as you want.

For Mendix 9 use font.colorParagraph i.s.o font.color.

import { brand, font } from "../custom-variables";

// Take the default values from the native theme
// eslint-disable-next-line camelcase
export const itvisors_nativestyledtext_NativeStyledText = {
    container: {},
    defaultTextStyle: {
        color: font.color,
        fontSize: font.size
    }
};

// Custom text styles.
// Add a block for each style. All TextStyle properties are allowed
export const nextAppointmentStyledText = {
    container: {},
    nameStyle: {
        color: brand.success
    },
    appointmentTime: {
        color: brand.primary
    }
};

Place these in a separate JavaScript file. It is assumed the file is placed in a subfolder under styles/native/app Depending on your folder structure you may need to adjust the import statement

In custom.js, add your new file. Replace app-custom with the folder name you used to put the file in.

export * from "https://raw.githubusercontent.com/Itvisors/mendix-NativeStyledText/v1.2.0/app-custom/nativeStyledText";

An example can be found in the GitHub repo.

Releases

Version: 1.2.0
Framework Version: 9.6.5
Release Notes: Optionally limit the text length, dark mode icons
Version: 1.1.0
Framework Version: 9.6.5
Release Notes: Mendix 9.6, new icons, tested with Atlas 3
Version: 1.0.1
Framework Version: 8.15.1
Release Notes: Doc change for Mx9 for styling
Version: 1.0.0
Framework Version: 8.15.1
Release Notes: Initial release