Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate UI package #391

Merged
merged 4 commits into from
Sep 26, 2022
Merged

Deprecate UI package #391

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5a5c0d3
docs (Overview) add instructions on how to install `jQuery`.
distalx Jul 24, 2022
8467a9b
Merge pull request #381 from distalx/issue-360
jankapunkt Aug 3, 2022
b8f6985
fix: deprecate UI package
jankapunkt Aug 26, 2022
83f3404
Merge branch 'release-3.0' into deprecate-ui-package
jankapunkt Aug 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/ui/package.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ Package.describe({
name: 'ui',
summary: "Deprecated: Use the 'blaze' package",
version: '1.0.13',
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably bump the version here and publish the package so that the warning gets out.

git: 'https://github.com/meteor/blaze.git'
git: 'https://github.com/meteor/blaze.git',
deprecated: true,
});

Package.onUse(function (api) {
Expand Down
33 changes: 33 additions & 0 deletions site/source/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,39 @@ Blaze is a Meteor-only package for now. Soon we will have Blaze on npm so you ca

Each new Meteor project you create has Blaze included (the `blaze-html-templates` package).

## Prerequisite

Earlier, `jQuery` was bundled with Blaze. In later versions Blaze does not have `jQuery` as a direct dependency. With some legacy Blaze packages you might encounter the following error.

```js
Uncaught Error: jQuery not found
```

To mitigate this error it is advised to install `jQuery` either as an `npm` or as a `atmospherejs` package.


#### install jquery with npm

Into project root.
```sh
meteor npm install jquery@latest --save
```
Import `jQuery` in `client/main.js`.
```js
import $ from 'jquery';
```

#### install jquery with atmospherejs

Into project root.
```sh
meteor add jquery@3.0.0
```
Import `jQuery` in `client/main.js`.
```js
import {$} from 'meteor/jquery';
```

## Details

Blaze has two major parts:
Expand Down