Discuss the implementation methods introduced by uniapp public methods

With the development of mobile Internet, developing APP has become one of the methods widely used by major enterprises. In the process of APP development, most applications will involve the use of some public methods. In order to facilitate maintenance and management, we can introduce these public methods into the project in the form of plug-ins. One of the more popular MVVM frameworks at present, uniapp, has provided a very convenient way to introduce plug-ins. This article will take you to discuss the implementation method of uniapp public method introduction.

1. Create a plug-in project

First we need to create a plug-in project (plug-in projects are basically the same as ordinary uniapp projects). After creating the project, we need to create a project named "uni_modules" in the project directory ” folder (if not available), which is used to store plug-ins.

2. Encapsulate the public method as a plug-in

Write a public method in the project (take toast as an example below):

export default {
  toast: (msg, duration = 1500, position = "bottom") => {
    uni.showToast({
      title: msg,
      icon: "none",
      duration: duration,
      position: position
    });
  }
};

Encapsulate the public method as a plug-in, steps As follows:

1. Create a .npmignore file in the uni_modules folder, add .vscode, .git and other folders or files will not be packaged.
2. Create a folder named your-plugin under the uni_modules folder, your-plugin is the name of the plug-in.
3. Create a package.json file in the your-plugin folder.

{
  "name": "@uni/your-plugin",
  "version": "1.0.0",
  "main": "index.js",
  "description": "your description",
  "author": "your name",
  "license": "MIT",
  "keywords": ["uni", "plugin"]
}

Among them, the name field is the name of the plug-in in the format of @uni/plug-in name, and the main field is the entry file , the keywords tag must contain the keywords uni and plugin.

4. Create an index.js file in the your-plugin folder.

import toast from "./toast.js";

const Plugin = {
  toast
};

export default {
  install(Vue) {
    Object.keys(Plugin).forEach(key => {
      Vue.prototype[`$${key}`] = Plugin[key];
    });
  }
};

Among them, toast is a public method, the Plugin object stores all the public methods that need to be exposed, and the install method uses to install the plug-in.

3. Push to npmjs

Push the plug-in to npmjs and it can be referenced by other projects. The steps are as follows:

1. In [npmjs official website](https:/ /www.npmjs.com/) (skip this step if you already have an account).
2. Use the npm adduser command in the terminal to log in.
3. Use the command npm init in the your-plugin folder to initialize.

npm init

4. To publish the plug-in, use the command npm publish.

npm publish

5. If you need to update the plug-in, just modify the version and publish it again.

4. Introduce plug-ins

In projects that need to use public methods, introduce plug-ins pushed to npmjs. The steps are as follows:

1. In the project directory Create a file named manifest.json and add the following code.

{
  "app-plus": {
    "plugins": {
      "@uni/your-plugin": {
        "version": "^1.0.0",
        "provider": "<your provider>"
      }
    }
  }
}

Among them, the version field is the version number of the plug-in, and the provider field is the plug-in provider, which needs to be specified when the plug-in is published to npmjs.

2. In pages that need to use public methods, execute the following code.

import yourPlugin from "@uni/your-plugin";

Vue.use(yourPlugin);

5. Use public methods

After introducing the plug-in, you can use public methods in the page. The following takes the toast method just created as an example:

this.$toast('Hello world!')

At this point, we have successfully introduced the uniapp public method.

To summarize, encapsulating public methods as plug-ins and pushing them to npmjs can greatly improve the efficiency of project development and the convenience of management. In actual projects, we can encapsulate some frequently used methods as plug-ins and introduce them in the above way.

The above is the detailed content of Discuss the implementation methods introduced by uniapp public methods. For more information, please follow other related articles on the PHP Chinese website!