iOS向けどこでもサポートSDKのウィジェット画面のカスタマイズ

iOS向けどこでもサポートSDKのウィジェット画面のカスタマイズ

どこでもサポートSDK（ソフトウェア開発キット）では、どこでもサポートのウィジェット画面をカスタマイズできます。このページでは、ウィジェット画面の各種内容のカスタマイズ方法について説明します。

標準のテーマ

どこでもサポートのウィジェット画面には、ライトとダークの2種類の標準テーマが用意されています。これらのテーマを適用するには、以下のメソッドを使用します。



テーマの変更に関するメソッドの呼び出しには、以下のimport文を使用します。これにより、「ZohoDeskPortalConfiguration」のコードがインポートされます。

Swift

  1. import ZohoDeskPortalConfiguration

Objective-C

  1. @import ZohoDeskPortalConfiguration;

ライトテーマ（標準）のメソッド

Swift

  1. ZDPThemeManager.setTheme(type: .light)

Objective-C

  1. [ZDPThemeManager setThemeWithType:ZDPThemeTypeLight];

ダークテーマのメソッド 

Swift

  1. ZDPThemeManager.setTheme(type: .dark)

Objective-C

  1. [ZDPThemeManager setThemeWithType:ZDPThemeTypeDark];
iOSのバージョン13以降では、どこでもサポートのテーマ（ライト、ダーク）をデバイスのテーマと連動させることが可能です。どこでもサポートとデバイスの外観を統一するのに役立ちます。どこでもサポートのテーマにデバイスと同じテーマを適用するには、以下のメソッドを使用します。

Swift

  1. ZDPThemeManager.setTheme(type: .system)

Objective-C

  1. [ZDPThemeManager setThemeWithType:ZDPThemeTypeSystem];
    •    「ZDPThemeType.system」は、iOSのバージョン13以上でのみ利用できます。
    •    iOS 13以降の場合、標準のテーマにはiOSのテーマが適用されます。iOS 13以前の場合、ライトテーマが適用されます。

テーマのカスタマイズ 

必要に応じて、標準のテーマをカスタマイズできます。標準のテーマの内容をもとに、操作画面の背景や要素の色を変更することが可能です。



ライトテーマ（標準）をカスタマイズするには、以下のメソッドを使用します。

Swift

  1. ZDPThemeManager.updateLightTheme(theme: <#ZDPThemeProtocol#>)

Objective-C

  1. [ZDPThemeManager updateLightThemeWithTheme:<#ZDPThemeProtocol#>];

ダークテーマをカスタマイズするには、以下のメソッドを使用します。

Swift

  1. ZDPThemeManager.updateDarkTheme(theme: <#ZDPThemeProtocol#>)

Objective-C

  1. [ZDPThemeManager updateDarkThemeWithTheme:<#ZDPThemeProtocol#>];

「ZDPThemeProtocol」では、どこでもサポートで使用する色の属性のリストを指定できます（例：「primaryTextColor」、「navigationBarTextColor」）。なお、プロトコル内の属性はすべて任意です。独自のクラスを作成した上で、対象のクラスの属性を実装し、「updateLightTheme」メソッドや「updateDarkTheme」メソッドの「ZDThemeProtocol」内に複数指定することも可能です。これにより、標準のテーマの色をクラスで設定した色に変更することができます。
テーマの色をカスタマイズする場合も、テーマの種類の設定が必要です。どこでもサポートのテーマには、設定内容に応じて、ダークテーマまたはライトテーマのいずれかが適用されます。

独自のフォント 

標準のフォントに加えて、どこでもサポートのウィジェット画面では独自のフォントを設定することができます。

ウィジェット画面で独自のフォントを表示するには、以下の手順を実施します。
    1.    プロジェクトにフォントを追加します。
    2.    アプリの「info.plist」ファイルを編集して、「Fonts provided by application」キーに独自のフォントを追加します。
    3.    このキーには、どこでもサポートのウィジェット画面で使用するすべてのフォントの名前が表示されます。



プロジェクトにフォントを追加した後、ウィジェット画面上のテキストに対象のフォントを適用するように設定を行う必要があります。

ウィジェット画面で独自のフォントを適用するには、以下のメソッドを使用します。

Swift

  1. ZDPortalConfiguration.customFontName = <#String#>

Objective-C

  1. ZDPortalConfiguration.customFontName = <#NSString#>;

独自のフォントを使用しない場合、ウィジェット画面にはOSのフォントが適用されます。どこでもサポートSDK（ソフトウェア開発キット）のバージョン2.0以降では、フォントのサイズを変更することもできます。なお、独自のフォントは、iOS 11以降のバージョンにのみ対応しています。