Skip to content

Commit e4390a3

Browse files
CB-12189 Document implementation attribute
This closes apache#671
1 parent 3da99ed commit e4390a3

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

www/docs/en/dev/plugin_ref/spec.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -521,6 +521,7 @@ arch(string) <br/> ==windows== | Allowed values: `x86`, `x64` or `ARM`. <br/> In
521521
device-target(string) <br/> ==windows== | Allowed values: `win` (or `windows`), `phone` or `all`. <br/> Indicates that the framework should only be included when building for the specified target device type.
522522
versions(string) <br/> ==windows== | Indicates that the framework should only be included when building for versions that match the specified version string. Value can be any valid node semantic version range string.
523523
target-dir(string) <br/> ==windows== | Indicates a subdirectory into which the framework should be copied. In practice, this is most important when plugin contains different framework versions for different chip architectures or device targets, but which have the same name. This allows you to specify different subfolders for each framework version so that they don't overlap each other.
524+
implementation(string) <br/> ==windows== | Sets the relative path to `.dll` file that contains implementation for WinMD component, written in C++.
524525
spec(string) <br/> ==ios== | Paired with `type="podspec"`, this is the spec string for the CocoaPod you want to install (static library only). CocoaPod support only exists in `cordova-ios 4.3.0` and `cordova-cli 6.4.0`. For your plugin, make sure you add the appropriate `<engine>` tags and `package.json` [dependencies](../guide/hybrid/plugins/index.html#specifying-cordova-dependencies) to ensure backwards-compatible support.
525526

526527
Examples:
@@ -562,6 +563,17 @@ Examples of using these Windows specific attributes:
562563
<framework src="src/windows/example.dll" target-dir="bin/x64" arch="x64" custom="true"/>
563564
```
564565

566+
Another example of using Windows-specific attributes to add a reference to WinMD components, written in C# and C++, whose API will be available at runtime:
567+
568+
```xml
569+
<!-- C# component that consists of one .winmd file -->
570+
<framework src="lib\windows\component.winmd" versions="<10.0" />
571+
<!-- C++ component with separated metadata and implementation-->
572+
<framework src="lib\windows\x86\cppcomponent.winmd"
573+
implementation="lib\windows\x86\cppcomponent.dll"
574+
target-dir="component\x86" arch="x86" versions=">=10.0" />
575+
```
576+
565577
## info
566578

567579
Additional information provided to users. This is useful when you require extra steps that can't be easily automated or are beyond the CLI's scope. The contents of this tag gets printed out when the CLI installs the plugin.

0 commit comments

Comments
 (0)