kmpalette

<img width="500px" src="https://yellow-cdn.veclightyear.com/835a84d5/f9f3bfd7-0de9-4bba-a1b2-5680061dd6c0.png" alt="logo"/> <br />

这是一个用于从图像生成调色板（包括主色）的Compose Multiplatform库。你可以将此库与MaterialKolor结合使用，根据图像生成动态Material主题。

支持从多个来源加载图像，详见来源。

**注意：**这是androidx.palette库的移植版本。

你可以在demo.kmpalette.com查看Web演示。

<img width="300px" src="https://yellow-cdn.veclightyear.com/835a84d5/7b6b20e4-002f-4530-bdf2-89d1a1db2932.gif" />

目录

• 平台
• 灵感来源
• 动态Material主题
• 设置
  • 版本目录
• 使用方法
  • 主色
  • 生成调色板
  • 来源
• 演示
• 功能请求
• 贡献
• 许可证
  • 与原始源代码的变更

平台

这个库是为Compose Multiplatform编写的，可以在以下平台上使用：

构件	Android	Desktop	iOS	macOS	Browser
core	✅	✅	✅	✅	✅
extensions-base64	✅	✅	✅	✅	✅
extensions-bytearray	✅	✅	✅	✅	✅
extensions-libres	✅	✅	✅	✅	✅
extensions-network	✅	✅	✅	✅	✅
extensions-file	✅	✅	✅	✅	❌

灵感来源

我创建这个库是因为我想在Compose Multiplatform应用中使用androidx.palette库。但是那个库不是多平台的，所以我决定移植它。

动态Material主题

想要根据图像中的主色创建动态Material主题吗？

查看我的另一个Compose Multiplatform库MaterialKolor！

设置

你可以使用Gradle将这个库添加到你的项目中。有几个可选的扩展库，详见来源。

版本目录

在libs.versions.toml中：

[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

要将其添加到多平台项目中，请将依赖项添加到公共源集：

[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

使用方法

要查看生成的KDocs，请访问docs.kmpalette.com

要使用这个库，你首先必须有一个ImageBitmap或Painter对象。

要获取ImageBitmap，你可以使用来源之一或使用为你创建它的库。

由于这个库是androidx.palette库的移植版本，使用方法非常相似。但是这个库提供了一些有用的扩展函数和可组合项。

在kmpalette-core中查找主库，包括Palette和Swatch对象的扩展。

包含了两个有用的@Composeable就绪的State对象：

• DominantColorState - 一个持有生成的主色Color对象的状态对象。
• PaletteState - 一个持有生成的Palette对象的状态对象。

它们可以这样使用：

主色

你可以使用rememberDominantColorState可组合项从ImageBitmap生成主色。这还将为你提供一个onColor作为文本颜色使用。

[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

你也可以通过指定DominantColorState.loader参数来使用Painter对象：

[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

由于主色的生成是一个可能失败的异步操作，你可以使用DominantColorState.result对象跟踪操作的结果。

如果你想过滤主色，你可以向rememberDominantColorState()传递一个lambda：

[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

要查看获取主色的更多示例，请参阅演示应用

生成颜色调色板

如果你想要一个完整的颜色调色板而不仅仅是一个主色，你可以使用rememberPaletteState可组合函数。这将提供一个Palette对象，其中包含几种不同的颜色Swatch，每个都有自己的颜色和_onColor_。

使用ImageBitmap：

[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

或使用Painter：

[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

由于主色的生成是一个可能失败的异步操作，你可以通过DominantColorState.result对象跟踪操作的结果。

要查看生成调色板的更多示例，请参阅演示应用

来源

kmpalette-core库提供了从ImageBitmap或Painter对象生成颜色调色板的核心功能。

该库为一些流行的来源提供了一些扩展工件。

工件	库	加载器	输入类	演示
extensions-base64	不适用	Base64Loader	String	Base64DemoScreen
extensions-bytearray	不适用	ByteArrayLoader	ByteArray	不适用
extensions-libres	libres	LibresLoader	Image	LibresPaletteScreen
extensions-network	ktor	NetworkLoader	Url	NetworkDemoScreen
extensions-file	okio	PathLoader, FilePathLoader	Path, String	不适用

这些扩展中的每一个都提供了一个ImageBitmapLoader对象，可用于从输入类生成ImageBitmap。例如，NetworkLoader可用于从Url生成ImageBitmap：

[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

Compose跨平台资源

从Compose跨平台1.6.0开始，处理资源的方式发生了变化。因此，本库已删除其扩展，因为不再需要它。

要从DrawableResource生成调色板，你可以使用@Composable imageResource()获取ImageBitmap，然后将其传递给默认加载器。

[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

演示

在demo目录中提供了一个演示应用。它是一个在Android、iOS和桌面上运行的Compose跨平台应用。

有关更多信息，请参阅README。

功能请求

如果你有功能请求，请开一个issue。如果你想实现功能请求，请参阅贡献部分。

贡献

我们始终欢迎贡献！如果你想贡献，请随时创建PR或开启issue。

许可证

androidx-palette模块根据Apache许可证2.0版获得许可。有关更多信息，请参阅他们的LICENSE和他们的仓库这里。

原始源代码的变更

• 将Java代码转换为Kotlin
• 将库转换为Kotlin跨平台

对于其余代码，请参阅LICENSE获取更多信息。