Ресурсы в Compose

Jetpack Compose может получить доступ к ресурсам, определенным в вашем проекте Android. В этом документе объясняются некоторые API-интерфейсы, которые Compose предлагает для этого.

Ресурсы — это дополнительные файлы и статический контент, который использует ваш код, например растровые изображения, определения макета, строки пользовательского интерфейса, инструкции анимации и т. д. Если вы не знакомы с ресурсами Android, ознакомьтесь с обзорным руководством по ресурсам приложения .

Струны

Наиболее распространенным типом ресурса являются ваши строки. Используйте API stringResource для получения строки, статически определенной в ваших XML-ресурсах.

// In the res/values/strings.xml file
// <string name="compose">Jetpack Compose</string>

// In your Compose code
Text(
    text = stringResource(R.string.compose)
)
ResourcesSnippets.kt

stringResource также работает с позиционным форматированием.

// In the res/values/strings.xml file
// <string name="congratulate">Happy %1$s %2$d</string>

// In your Compose code
Text(
    text = stringResource(R.string.congratulate, "New Year", 2021)
)
ResourcesSnippets.kt

Строковые множественные числа (экспериментально)

Используйте API pluralStringResource для загрузки множественного числа с определенным количеством.

// In the res/strings.xml file
// <plurals name="runtime_format">
//    <item quantity="one">%1$d minute</item>
//    <item quantity="other">%1$d minutes</item>
// </plurals>

// In your Compose code
Text(
    text = pluralStringResource(
        R.plurals.runtime_format,
        quantity,
        quantity
    )
)
ResourcesSnippets.kt

При использовании метода pluralStringResource вам необходимо передать счетчик дважды, если ваша строка содержит форматирование строки с числом. Например, для строки %1$d minutes первый параметр count выбирает соответствующую строку во множественном числе, а второй параметр count вставляется в заполнитель %1$d . Если ваши строки во множественном числе не включают форматирование строк, вам не нужно передавать третий параметр в pluralStringResource .

Дополнительную информацию о множественном числе см. в документации по строкам количества .

Размеры

Аналогичным образом используйте API-интерфейс dimensionResource , чтобы получить измерения из XML-файла ресурса.

// In the res/values/dimens.xml file
// <dimen name="padding_small">8dp</dimen>

// In your Compose code
val smallPadding = dimensionResource(R.dimen.padding_small)
Text(
    text = "...",
    modifier = Modifier.padding(smallPadding)
)
ResourcesSnippets.kt

Цвета

Если вы постепенно внедряете Compose в своем приложении, используйте API colorResource для получения цветов из XML-файла ресурсов.

// In the res/colors.xml file
// <color name="purple_200">#FFBB86FC</color>

// In your Compose code
Divider(color = colorResource(R.color.purple_200))
ResourcesSnippets.kt

colorResource работает, как и ожидалось, со статическими цветами, но выравнивает ресурсы списка состояний цвета .

Предупреждение. Отдавайте предпочтение цветам из темы, а не жестко запрограммированным цветам. Несмотря на то, что доступ к цветам можно получить с помощью функции colorResource , рекомендуется, чтобы цвета вашего приложения были определены в MaterialTheme , к которому можно получить доступ из ваших составных элементов, например MaterialTheme.colors.primary . Подробнее об этом читайте в документации Design Systems in Compose .

Векторные ресурсы и графические ресурсы

Используйте API-интерфейс painterResource для загрузки векторных изображений или растровых форматов ресурсов, таких как PNG. Вам не нужно знать тип рисуемого объекта, просто используйте painterResource в компонуемых Image или модификаторах paint .

// Files in res/drawable folders. For example:
// - res/drawable-nodpi/ic_logo.xml
// - res/drawable-xxhdpi/ic_logo.png

// In your Compose code
Icon(
    painter = painterResource(id = R.drawable.ic_logo),
    contentDescription = null // decorative element
)
ResourcesSnippets.kt

painterResource декодирует и анализирует содержимое ресурса в основном потоке.

Примечание. В отличие от Context.getDrawable , painterResource может загружать только типы Drawable платформы BitmapDrawable и VectorDrawable .

Анимированные векторные рисунки

Используйте API AnimatedImageVector.animatedVectorResource для загрузки XML-файла с возможностью рисования анимированного вектора. Метод возвращает экземпляр AnimatedImageVector . Чтобы отобразить анимированное изображение, используйте метод rememberAnimatedVectorPainter , чтобы создать Painter , который можно использовать в составных компонентах Image и Icon . Логический параметр atEnd метода rememberAnimatedVectorPainter указывает, должно ли изображение отображаться в конце всех анимаций. При использовании с изменяемым состоянием изменения этого значения вызывают соответствующую анимацию.

// Files in res/drawable folders. For example:
// - res/drawable/ic_hourglass_animated.xml

// In your Compose code
val image =
    AnimatedImageVector.animatedVectorResource(R.drawable.ic_hourglass_animated)
val atEnd by remember { mutableStateOf(false) }
Icon(
    painter = rememberAnimatedVectorPainter(image, atEnd),
    contentDescription = null // decorative element
)
ResourcesSnippets.kt

Иконки

Jetpack Compose поставляется с объектом Icons , который является точкой входа для использования значков материалов в Compose. Существует пять различных тем значков: «Заливка », «Очерченный» , «Закругленный» , «Двухцветный» и «Резкий» . Каждая тема содержит одни и те же значки, но с отдельным визуальным стилем. Обычно вам следует выбрать одну тему и использовать ее во всем приложении для обеспечения единообразия.

Чтобы нарисовать значок, вы можете использовать составной Icon , который применяет оттенок и обеспечивает размер макета, соответствующий значку.

Icon(Icons.Rounded.Menu, contentDescription = "Localized description")
ResourcesSnippets.kt

Некоторые из наиболее часто используемых значков доступны как часть зависимости androidx.compose.material . Чтобы использовать любые другие значки материалов, добавьте расширенную зависимость material-icons-extended в файл build.gradle .

dependencies {
  def composeBom = platform('androidx.compose:compose-bom:2024.09.03')
  implementation composeBom

  implementation 'androidx.compose.material:material-icons-extended'
}

Примечание. Иконки сохраняют те же имена, что и Material, но их имя Snake_case преобразуется в PascalCase. Например, add_alarm становится AddAlarm . Значки, начинающиеся с цифры, например 360, имеют префикс _ и становятся _360 .

Предупреждение: material-icons-extended — это большая библиотека, которая может повлиять на размер вашего APK. По этой причине рассмотрите возможность использования R8/Proguard в производственных сборках для удаления неиспользуемых ресурсов. Кроме того, из-за большого размера время сборки вашего проекта и время загрузки предварительных просмотров Android Studio могут увеличиться во время разработки. С другой стороны, material-icons-extended позволяет выполнять итерации быстрее благодаря быстрому доступу к последним версиям всех значков. Вы также можете использовать эту библиотеку для копирования исходного кода значка, чтобы иметь фиксированную копию в вашем приложении, или, альтернативно, импортировать значки с помощью функции импорта векторных ресурсов Android Studio .

Шрифты

Чтобы использовать шрифты в Compose, загрузите и добавьте файлы шрифтов непосредственно в APK-файлы, поместив их в папку res/font .

Загрузите каждый шрифт с помощью Font API и создайте с ним FontFamily , который вы сможете использовать в экземплярах TextStyle для создания собственной Typography . Ниже приведен код, взятый из примера компоновки Crane и его файла Typography.kt .

// Define and load the fonts of the app
private val light = Font(R.font.raleway_light, FontWeight.W300)
private val regular = Font(R.font.raleway_regular, FontWeight.W400)
private val medium = Font(R.font.raleway_medium, FontWeight.W500)
private val semibold = Font(R.font.raleway_semibold, FontWeight.W600)

// Create a font family to use in TextStyles
private val craneFontFamily = FontFamily(light, regular, medium, semibold)

// Use the font family to define a custom typography
val craneTypography = Typography(
    titleLarge = TextStyle(
        fontFamily = craneFontFamily
    ) /* ... */
)

// Pass the typography to a MaterialTheme that will create a theme using
// that typography in the part of the UI hierarchy where this theme is used
@Composable
fun CraneTheme(content: @Composable () -> Unit) {
    MaterialTheme(typography = craneTypography) {
        content()
    }
}
ResourcesSnippets.kt

Информацию об использовании загружаемых шрифтов в Compose см. на странице «Загружаемые шрифты» .

Узнайте больше о типографике в документации Theming in Compose.

{% дословно %} {% дословно %}