Table of Contents
1. Create a plug-in project
2. Encapsulate the public method as a plug-in
3. Push to npmjs
4. Introduce plug-ins
5. Use public methods
Home Web Front-end uni-app Discuss the implementation methods introduced by uniapp public methods

Discuss the implementation methods introduced by uniapp public methods

Apr 20, 2023 pm 01:53 PM

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
    });
  }
};
Copy after login

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"]
}
Copy after login

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.

  1. 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];
    });
  }
};
Copy after login

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
Copy after login
  1. To publish the plug-in, use the command npm publish.
npm publish
Copy after login
  1. 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>"
      }
    }
  }
}
Copy after login

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.

  1. In pages that need to use public methods, execute the following code.
import yourPlugin from "@uni/your-plugin";

Vue.use(yourPlugin);
Copy after login

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!')
Copy after login

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!

Statement of this Website
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn

Hot AI Tools

Undresser.AI Undress

Undresser.AI Undress

AI-powered app for creating realistic nude photos

AI Clothes Remover

AI Clothes Remover

Online AI tool for removing clothes from photos.

Undress AI Tool

Undress AI Tool

Undress images for free

Clothoff.io

Clothoff.io

AI clothes remover

Video Face Swap

Video Face Swap

Swap faces in any video effortlessly with our completely free AI face swap tool!

Hot Tools

Notepad++7.3.1

Notepad++7.3.1

Easy-to-use and free code editor

SublimeText3 Chinese version

SublimeText3 Chinese version

Chinese version, very easy to use

Zend Studio 13.0.1

Zend Studio 13.0.1

Powerful PHP integrated development environment

Dreamweaver CS6

Dreamweaver CS6

Visual web development tools

SublimeText3 Mac version

SublimeText3 Mac version

God-level code editing software (SublimeText3)

What are the different types of testing that you can perform in a UniApp application? What are the different types of testing that you can perform in a UniApp application? Mar 27, 2025 pm 04:59 PM

The article discusses various testing types for UniApp applications, including unit, integration, functional, UI/UX, performance, cross-platform, and security testing. It also covers ensuring cross-platform compatibility and recommends tools like Jes

What debugging tools are available for UniApp development? What debugging tools are available for UniApp development? Mar 27, 2025 pm 05:05 PM

The article discusses debugging tools and best practices for UniApp development, focusing on tools like HBuilderX, WeChat Developer Tools, and Chrome DevTools.

How can you reduce the size of your UniApp application package? How can you reduce the size of your UniApp application package? Mar 27, 2025 pm 04:45 PM

The article discusses strategies to reduce UniApp package size, focusing on code optimization, resource management, and techniques like code splitting and lazy loading.

How can you use lazy loading to improve performance? How can you use lazy loading to improve performance? Mar 27, 2025 pm 04:47 PM

Lazy loading defers non-critical resources to improve site performance, reducing load times and data usage. Key practices include prioritizing critical content and using efficient APIs.

How can you optimize images for web performance in UniApp? How can you optimize images for web performance in UniApp? Mar 27, 2025 pm 04:50 PM

The article discusses optimizing images in UniApp for better web performance through compression, responsive design, lazy loading, caching, and using WebP format.

What are some common patterns for managing complex data structures in UniApp? What are some common patterns for managing complex data structures in UniApp? Mar 25, 2025 pm 02:31 PM

The article discusses managing complex data structures in UniApp, focusing on patterns like Singleton, Observer, Factory, and State, and strategies for handling data state changes using Vuex and Vue 3 Composition API.

What are computed properties in UniApp? How are they used? What are computed properties in UniApp? How are they used? Mar 25, 2025 pm 02:23 PM

UniApp's computed properties, derived from Vue.js, enhance development by providing reactive, reusable, and optimized data handling. They automatically update when dependencies change, offering performance benefits and simplifying state management co

How does UniApp handle global configuration and styling? How does UniApp handle global configuration and styling? Mar 25, 2025 pm 02:20 PM

UniApp manages global configuration via manifest.json and styling through app.vue or app.scss, using uni.scss for variables and mixins. Best practices include using SCSS, modular styles, and responsive design.

See all articles