text-string.md

TextString

Source

Loads text strings from our database and displays them. Handles replacements and changing the string via CTRL + Click (only internal).

Usage

You should have the chayns-components package installed. If that is not the case already, run

yarn add chayns-components

or

npm i chayns-components

After the chayns-components package is installed, you can import the component and use it with React:

import React from 'react'
import { TextString } from 'chayns-components';

// ...

<TextString {...} />

Props

The TextString-component takes the following props:

Name	Type	Default	Required
stringName	string
replacements	{ [key: string]: string | number }	{}
children	ReactNode	<p />
useDangerouslySetInnerHTML	boolean	false
language	string
fallback	string	''
setProps	{ [key: string]: object | string | number }	{}
preventNoTranslate	boolean	false

stringName

stringName?: string

The string id of the text you want to display.

---

replacements

replacements?: { [key: string]: string | number }

An map of replacements in the form of an object with the string that should be replaced as its key and the replacement as its value.

---

children

children?: ReactNode

The child node the text should be rendered into.

---

useDangerouslySetInnerHTML

useDangerouslySetInnerHTML?: boolean

Wether the component should render HTML content in the string.

---

language

language?: string

The language of the string, provided as a ISO 639-1 code. Please note that the language has to be loaded beforehand for this to work.

---

fallback

fallback?: string

A fallback string that will be displayed if the main string failed to load.

---

setProps

setProps?: { [key: string]: object | string | number }

The string names of the children props, e.g. placeholder or accordion head.

---

preventNoTranslate

preventNoTranslate?: boolean

Prevents setting the no-translate class to the children when the language of the text string matches the current language of the user.