# @suntree/tarojs-plugin-platform-miniprogram

> @tarojs/plugin-platform-weapp custom wxml support

Latest version **1.0.8** (published 2022-09-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @suntree/tarojs-plugin-platform-miniprogram
pnpm add @suntree/tarojs-plugin-platform-miniprogram
yarn add @suntree/tarojs-plugin-platform-miniprogram
bun add @suntree/tarojs-plugin-platform-miniprogram
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.8 |
| Published | 2022-09-21 |
| First published | 2022-09-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 15.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | suntree |
| Maintainers | liuhuapiaoyuan |

## Links

- npm: https://www.npmjs.com/package/@suntree/tarojs-plugin-platform-miniprogram
- npm.io page: https://npm.io/package/@suntree/tarojs-plugin-platform-miniprogram

## Recent versions

- 1.0.8 (latest) — 2022-09-21
- 1.0.2 — 2022-09-21
- 1.0.1 — 2022-09-21
- 1.0.0 — 2022-09-21

## README

# tarojs-plugin-platform-miniprogram

[![](https://img.shields.io/npm/v/tarojs-plugin-platform-miniprogram)](https://www.npmjs.com/package/tarojs-plugin-platform-miniprogram)
[![Node.js Package](https://github.com/baranwang/tarojs-plugin-platform-miniprogram/actions/workflows/npm-publish.yml/badge.svg)](https://github.com/baranwang/tarojs-plugin-platform-miniprogram/actions/workflows/npm-publish.yml)
![](https://img.shields.io/npm/l/tarojs-plugin-platform-miniprogram)

[@tarojs/plugin-platform-weapp](https://github.com/NervJS/taro/tree/next/packages/taro-weapp) 自定义 wxml 支持，目前可主要用于支持 [`page-meta`](https://developers.weixin.qq.com/miniprogram/dev/component/page-meta.html) 和 [`navigation-bar`](https://developers.weixin.qq.com/miniprogram/dev/component/navigation-bar.html)，[`Taro`](https://github.com/NervJS/taro) 版本需大于 `3.1.0`


### 2022-09-21
- 该版本升级了对taro 3.5.X的插件支持


## 安装

```shell
npm i -D tarojs-plugin-platform-miniprogram
# or
pnpm add -D tarojs-plugin-platform-miniprogram
# or
yarn add -D tarojs-plugin-platform-miniprogram
```

## 配置

`config/index.js` 中引入 plugin

```javascript
const config = {
  // ...
  plugins: ["tarojs-plugin-platform-miniprogram"],
  // ...
};

// or

const config = {
  // ...
  plugins: [
    [
      "tarojs-plugin-platform-miniprogram",
      /**
       * @type {import('tarojs-plugin-platform-miniprogram').Options}}
       */
      {
        prefix: "<page-meta></page-meta>", // or path.resolve(__dirname, './prefix.wxml')

        /**
         * @version 0.1.0
         */
        include: [
          "pages/index/index",
          "pages/logs/logs",
          new RegExp('^pages/foo'),
        ],
        exclude: []
      },
    ],
  ],
  // ...
};
```

修改 `package.json`

```diff
{
  "scripts: {
-   "build:weapp": "taro build --type weapp",
+   "build:weapp": "taro build --type miniprogram",
  }
}
```

## 使用

### 通用

```javascript
const { page } = Taro.getCurrentinstance();

page.setData({
  pageMeta: {
    backgroundTextStyle: 'dark',
    // ...
  },
  navigationBar: {
    // ...
  },
});
```

### React

除了通用方法外，为 React 封装了组件

```tsx
import { PageMeta, NavigationBar } from "tarojs-plugin-platform-miniprogram/dist/components";

export default () => {
  return (
    <>
      <PageMeta backgroundTextStyle='dark'>
        <NavigationBar title='Awesome Taro' />
      </PageMeta>
    </>
  )
}
```

---
_Source: https://npm.io/package/@suntree/tarojs-plugin-platform-miniprogram · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._