Pro Packages
A Pro plan gives you access to all 31,204 Lineicons icons. The Pro packages deliver the Pro icons as components, one package per style. They work the same way as @lineiconshq/free-icons. The only difference is that you download the package files from your account and install them from a local file instead of the npm registry.
Before You Start
You need:
- An active Pro plan
- A React, Vue, Angular, or React Native project
- The wrapper package for your framework (see Step 4)
Available Packages
There is one package per style. All packages are at version 1.0.0.
| Style | Package name | File |
|---|---|---|
| Stroke | @lineiconshq-pro/core-stroke | lineiconshq-pro-core-stroke-5.2.0.tgz |
| Outlined | @lineiconshq-pro/core-outlined | lineiconshq-pro-core-outlined-5.2.0.tgz |
| Solid | @lineiconshq-pro/core-solid | lineiconshq-pro-core-solid-5.2.0.tgz |
| Duotone | @lineiconshq-pro/core-duotone | lineiconshq-pro-core-duotone-5.2.0.tgz |
| Bulk | @lineiconshq-pro/core-bulk | lineiconshq-pro-core-bulk-5.2.0.tgz |
Step 1: Download the Package Files
- Log in to your Lineicons account.
- Go to Profile > Downloads.
- Download the
.tgzfile for each style you need.
Step 2: Add the Files to Your Project
Create a vendor/lineicons folder in your project root and move the files into it:
my-app/
├── package.json
├── src/
└── vendor/
└── lineicons/
├── lineiconshq-pro-core-outlined-5.2.0.tgz
└── lineiconshq-pro-core-solid-5.2.0.tgzStep 3: Install the Packages
Install each file from its local path:
npm
npm install ./vendor/lineicons/lineiconshq-pro-core-outlined-5.2.0.tgz ./vendor/lineicons/lineiconshq-pro-core-solid-5.2.0.tgzYour package.json now points to the local files with file: paths:
{
"dependencies": {
"@lineiconshq-pro/core-outlined": "file:vendor/lineicons/lineiconshq-pro-core-outlined-5.2.0.tgz",
"@lineiconshq-pro/core-solid": "file:vendor/lineicons/lineiconshq-pro-core-solid-5.2.0.tgz"
}
}Step 4: Install the Wrapper
The Pro packages contain the icon data. The wrapper package renders them. Skip this step if you already set up free icons, since the wrapper is the same.
React
npm install @lineiconshq/react-lineiconsStep 5: Use Pro Icons
Pro icons are named without a style suffix. The style comes from the package you import from, so AlarmError from @lineiconshq-pro/core-outlined is the outlined version.
To find an icon’s import name, open the icon on lineicons.com/icons and click Copy Icon Name in the details panel. Convert the name to PascalCase for the import, for example alarm-error becomes AlarmError.
React
import { Lineicons } from "@lineiconshq/react-lineicons";
import { AlarmError } from "@lineiconshq-pro/core-outlined";
import { BadgeBolt2 } from "@lineiconshq-pro/core-solid";
function App() {
return (
<div>
<Lineicons icon={AlarmError} size={24} color="blue" strokeWidth={1.5} />
<Lineicons icon={BadgeBolt2} size={40} color="orange" />
</div>
);
}
export default App;For Angular, see Using Pro Icons in Angular.
Using Free and Pro Together
You can install @lineiconshq/free-icons and the Pro packages side by side. Free icon names end with a style suffix (Home2Outlined), and Pro icon names do not (AlarmError), so they rarely clash.
Names do clash when you use the same Pro icon in two styles. Rename one on import:
import { AlarmError } from "@lineiconshq-pro/core-outlined";
import { AlarmError as AlarmErrorSolid } from "@lineiconshq-pro/core-solid";The same pattern works for free icons:
import { Home2Outlined as Home2OutlinedFree } from "@lineiconshq/free-icons";Keep @lineiconshq/free-icons installed if you use free icons. The Pro packages do not include the free icon set.
Deploying
Installs work on CI and hosting platforms because package.json uses file: paths. Commit the vendor/lineicons folder so the files are there when your build runs npm install.
Only commit the .tgz files to private repositories. Never publish them to npm or push them to a public repository. The files are licensed to your Pro plan.
Updating to a New Version
- Download the new
.tgzfiles from Profile > Downloads. - Move them into
vendor/lineicons. - Reinstall from the new paths, for example
npm install ./vendor/lineicons/<new-file>.tgz. - Delete the old
.tgzfiles. - Commit
package.json, your lockfile, and thevendor/lineiconsfolder.
See the Changelog for what changed in each release.
Troubleshooting
Cannot find module '@lineiconshq-pro/core-outlined': The package is not installed. Run the install command from Step 3 for that style.ENOENTduring install: The path in the command or inpackage.jsondoes not match the file. Check the folder and file name, including the version number.- Install fails on CI only: The
.tgzfiles are not committed. Check that.gitignoredoes not excludevendor/or*.tgz. - An imported icon is
undefined: The name does not exist in that package. Pro names have no style suffix, soAlarmErrorOutlinedisundefinedwhileAlarmErrorworks. Free icons such asHome2Outlinedare not in the Pro packages; import them from@lineiconshq/free-icons.
Still stuck? Contact support or ask on Discord .