1 Star 1 Fork 1

CHINASOFT3_OHOS / MagicaSakura

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

MagicaSakura

项目介绍

  • 项目名称:MagicaSakura
  • 所属系列:openharmony 第三方组件适配移植
  • 功能:MagicaSakura是一个openharmony多主题库,支持每日色彩主题和夜间主题
  • 项目移植状态:主功能完成
  • 调用差异:无
  • 开发版本:sdk6,DevEco Studio2.2 beta1
  • 基线版本:Releases 0.1.8

效果演示

sc1

安装教程

1.在项目根目录下的build.gradle文件中,

allprojects {
   repositories {
       maven {
           url 'https://s01.oss.sonatype.org/content/repositories/releases/'
       }
   }
}

2.在entry模块的build.gradle文件中,

dependencies {
   implementation('com.gitee.chinasoft_ohos:MagicaSakura:1.0.2')
   ......  
}

如无法运行,删除项目.gradle,.idea,build,gradle,build.gradle文件, 并依据自己的版本创建新项目,将新项目的对应文件复制到根目录下


使用说明

  • 步骤1 :

在element/color.json中定义你的应用全局主题颜色变量,如:

{
  "color": [
    {
      "name": "theme_color_primary",
      "value": "#fb7299"
    },
    {
      "name": "theme_color_primary_dark",
      "value": "#b85671"
    },
    {
      "name": "theme_color_primary_trans",
      "value": "#99f0486c"
    }]
}

必须使用这些颜色变量在布局xml中,这些xml文件需要自动适应不同的主题样式。如果你使用直接的颜色值或其他颜色变量,将失去适应不同的主题风格功能

  • 步骤2 :

实现ThemeUtils。在应用程序中切换颜色界面;你可以结合颜色变量定义自己的规则(在步骤1中定义),在选择不同主题时切换不同的颜色。

public class MyApplication extends AbilityPackage implements ThemeUtils.switchColor {
    @Override
       public void onInitialize() {
           super.onInitialize();
           ThemeUtils.setSwitchColor(this);
       }
     
   @Override
   public int replaceColorById(Context context, Color color) {
       if (ThemeHelper.isDefaultTheme(context)) {
           return getColorValue(ResourceTable.Color_theme_color_primary);
       }
       int theme = getThemeColorId(context);
       return getColorValue(theme);
   }

   @Override
   public int replaceColor(Context context, int colorValue) {
       if (ThemeHelper.isDefaultTheme(context)) {
           return colorValue;
       }
      ...
   }
     
}
  • 步骤3 :

这个库提供了一系列Tintxxx小控件,其中包括最常见的ohos小控件。

当你的应用中的某些地方需要适配多个主题时,你可以使用这些Tintxxx widgets 结合颜色变量(在步骤1中定义)或者颜色json(使用颜色变量)或绘制xml(颜色变量),那么它们将自动适应。

  • 绘制 Xml Tintxxx widgets支持常见的绘制 xml标签,如, , 等。

    (注意:当使用不支持绘制的xml标签时,就不能适应多主题)

    下面是一个例子:

    //color.json
    //tint directly
    <state-container
        xmlns:ohos="http://schemas.huawei.com/res/ohos">
    
    
        <item
            ohos:element="$color:theme_color_primary_dark"
            ohos:state="component_state_pressed" />
    
        <item
            ohos:element="$color:theme_color_primary"
            ohos:state="component_state_empty" />
    </state-container>
    
    // set image 
    <state-container
        xmlns:ohos="http://schemas.huawei.com/res/ohos">
    
        <item
            ohos:element="$media:ic_lock_outline_white_24dp"
            ohos:state="component_state_focused" />
    
        <item
            ohos:element="$media:ic_lock_outline_white_24dp"
            ohos:state="component_state_empty" />
    </state-container>
  • Layout Xml Tintxxx控件可以直接在布局xml中着色,支持最常见的openharmony可绘制attrSet,如background, src, drawableLeft, button等。

    (注意:在布局xml中直接着色时,必须使用颜色变量(在步骤1中定义),否则适应不同的主题样式将不起作用)

    下面是一个例子:

    // selector_lock.xml
    <state-container
        xmlns:ohos="http://schemas.huawei.com/res/ohos">
    
        <item ohos:element="$media:ic_lock_open_white_24dp"
              ohos:state="component_state_pressed"/>
    
        <item ohos:element="$media:ic_lock_white_24dp"
              ohos:state="component_state_empty"/>
    
    </state-container>
    
    // TintTextView
    // The selector_lock and selector_text is a ColorStateList
     <com.bilibili.magicasakura.widgets.TintTextView
             ohos:id="$+id:title"
             ohos:height="match_content"
             ohos:width="match_content"
             ohos:clickable="true"
             ohos:element_left="$graphic:selector_lock"
             ohos:element_padding="8vp"
             ohos:text="$string:textview_title_unlock"
             ohos:text_alignment="vertical_center"
             ohos:text_color="#111111"
             ohos:text_size="19fp"
             app:drawableLeftStateTint="$color:theme_color_primary"
             app:drawableLeftTint="$color:gray_dark" />

    下面是支持Tintxxx控件attr的表格:

    attr tint
    background backgroundTint
    src imageTint
    button compoundButtonTint
    drawableXxx drawableXxxTint
    progress progressTint,progressIndeterminateTint
    track trackTint
    thumb thumbTint
  • Java code Java代码Tintxxx小控件也可以在java代码中着色。着色绘制的方式与ohos原生方法相同。

    下面是一个例子:

    tintTextView.setBackgroundResource(ResourceTable.Graphic_selector_shape_lock);
    
    tintImageView.setImageResource(ResourceTable.Graphic_selecor_png_lock);
    tintImageView.setImageTintList(ResourceTable.Color_selector_color_lock);
  • 步骤4 :

    库提供实用工具类Themeutils来满足一些特殊需求或您自己的定制小部件。

    实用程序类Themeltils主要提供了着色绘制和转换颜色变量(在步骤1中定义)的方法,当前的主题color.

    ThemeUtils.replaceColorById(context, ResourceTable.Color_selector_color.lock);

测试信息

CodeCheck代码测试无异常
CloudTest代码测试无异常
病毒安全检测通过
当前版本demo功能与原组件基本无差异

版本迭代

  • 1.0.2

版权和许可信息

Copyright 2016 Bilibili

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

MagicaSakura是一个openharmony多主题库,支持每日色彩主题和夜间主题 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/chinasoft3_ohos/MagicaSakura.git
git@gitee.com:chinasoft3_ohos/MagicaSakura.git
chinasoft3_ohos
MagicaSakura
MagicaSakura
master

搜索帮助