Skip to content

Commit 8d22af2

Browse files
committed
feat: remove jira ticket support
1 parent 449f0f8 commit 8d22af2

13 files changed

Lines changed: 18 additions & 590 deletions

File tree

package.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "react-linkify-it",
33
"author": "Ananto Ghosh",
44
"version": "1.0.8",
5-
"description": "**A super tiny <1KB, dependency-free, highly customizable React utility to turn any pattern in your text into clickable links or custom components. Instantly linkify URLs, emails, Jira tickets, Twitter handles, hashtags, or anything else—out of the box or with your own rules.**",
5+
"description": "A super tiny <1KB, dependency-free, highly customizable React utility to turn any pattern in your text into clickable links or custom components. Instantly linkify URLs, emails, twitter handles, hashtags, mentions or anything else—out of the box or with your own rules.",
66
"license": "MIT",
77
"type": "module",
88
"source": "src/index.tsx",
@@ -55,7 +55,6 @@
5555
"linkify",
5656
"link",
5757
"url",
58-
"jira",
5958
"email",
6059
"twitter",
6160
"autolink",

readme.md

Lines changed: 7 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# react-linkify-it 🔗
22

3-
**A super tiny <1KB, dependency-free, highly customizable React utility to turn any pattern in your text into clickable links or custom components. Instantly linkify URLs, emails, Jira tickets, Twitter handles, hashtags, or anything else—out of the box or with your own rules.**
3+
**A super tiny <1KB, dependency-free, highly customizable React utility to turn any pattern in your text into clickable links or custom components. Instantly linkify URLs, emails, twitter handles, hashtags, mentions or anything else—out of the box or with your own rules.**
44

55
[![Npm version](https://badgen.net/npm/v/react-linkify-it)](https://www.npmjs.com/package/react-linkify-it)
66
[![Build](https://github.com/anantoghosh/react-linkify-it/actions/workflows/node.js.yml/badge.svg)](https://github.com/anantoghosh/react-linkify-it/actions/workflows/node.js.yml)
@@ -20,7 +20,7 @@
2020
-**Super tiny**: Less than 1KB gzipped after tree shaking!
2121
- 🪶 **Zero dependencies**: No bloat, No extra dependencies. Just a single file.
2222
- 🛠️ **Ultra customizable**: Linkify any pattern, use your own regex, wrap with any component. Adjust to your specific case as required.
23-
- 🔗 **Prebuilt for you**: URLs, emails, Jira tickets, Twitter handles—ready out of the box.
23+
- 🔗 **Prebuilt for you**: URLs, emails, twitter handles, hashtags, mentions - ready out of the box.
2424
- 💧 **Generic**: Not just links, wrap any pattern with _any_ component.
2525
- 🧩 **Composable**: Nest, combine, and mix patterns as you like.
2626
- 🚀 **Blazing fast**: Single-pass processing.
@@ -79,30 +79,7 @@ const App = () => (
7979
);
8080
```
8181

82-
#### 2. `<LinkItJira>`
83-
84-
**What it does:**
85-
Finds Jira ticket keys (e.g. `PROJ-123`) and links them to your Jira instance.
86-
87-
**Props:**
88-
89-
- `children` (required): Content to linkify.
90-
- `domain` (required): Base URL of your Jira instance (e.g. `https://projectid.atlassian.net`).
91-
- `className` (optional): CSS class for the anchor tag.
92-
93-
```jsx
94-
import { LinkItJira } from 'react-linkify-it';
95-
96-
const App = () => (
97-
<div className="App">
98-
<LinkItJira domain="https://projectid.atlassian.net" className="jira-link">
99-
hello AMM-123 ticket
100-
</LinkItJira>
101-
</div>
102-
);
103-
```
104-
105-
#### 3. `<LinkItTwitter>`
82+
#### 2. `<LinkItTwitter>`
10683

10784
**What it does:**
10885
Finds Twitter handles (e.g. `@username`) and links them to Twitter profiles.
@@ -124,7 +101,7 @@ const App = () => (
124101
);
125102
```
126103

127-
#### 4. `<LinkItEmail>`
104+
#### 3. `<LinkItEmail>`
128105

129106
**What it does:**
130107
Finds email addresses and wraps them in `mailto:` links.
@@ -146,7 +123,7 @@ const App = () => (
146123
);
147124
```
148125

149-
#### 5. `<LinkIt>` (Generic Component)
126+
#### 4. `<LinkIt>` (Generic Component)
150127

151128
**What it does:**
152129
Lets you linkify any pattern using your own regex and custom component. Perfect for advanced use cases or custom patterns.
@@ -180,7 +157,7 @@ const App = () => (
180157
);
181158
```
182159

183-
#### 6. `<LinkItHashtag>`
160+
#### 5. `<LinkItHashtag>`
184161

185162
**What it does:**
186163
Finds hashtags (e.g. `#OpenSource`, `#日本語`) and links them to your chosen platform using a URL template.
@@ -209,7 +186,7 @@ const App = () => (
209186
);
210187
```
211188

212-
#### 7. `<LinkItMention>`
189+
#### 6. `<LinkItMention>`
213190

214191
**What it does:**
215192
Finds mentions (e.g. `@username`, `@ユーザー`) and links them to your chosen platform using a URL template.
@@ -297,10 +274,6 @@ All prebuilt components accept the following props:
297274
- `className` (string, optional): CSS class for the anchor tag.
298275
- `children` (string | ReactNode): Content to linkify.
299276

300-
`LinkItJira` additionally requires:
301-
302-
- `domain` (string, required): Base URL of your Jira instance (e.g. `https://projectid.atlassian.net`).
303-
304277
The generic `LinkIt` component accepts:
305278

306279
- `component`: Function `(match, key) => ReactNode` to render each match.
@@ -320,7 +293,6 @@ import {
320293
urlRegex,
321294
emailRegex,
322295
twitterRegex,
323-
jiraRegex,
324296
} from 'react-linkify-it';
325297
```
326298

src/components/JiraComponent.tsx

Lines changed: 0 additions & 35 deletions
This file was deleted.

src/components/LinkItJira.tsx

Lines changed: 0 additions & 43 deletions
This file was deleted.

src/components/index.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
export { UrlComponent } from './UrlComponent';
22
export { EmailComponent } from './EmailComponent';
33
export { TwitterComponent } from './TwitterComponent';
4-
export { JiraComponent } from './JiraComponent';
54
export { HashTagComponent } from './HashTagComponent';
65
export { MentionComponent } from './MentionComponent';
76
export { LinkIt } from './LinkIt';
87
export { LinkItUrl } from './LinkItUrl';
98
export { LinkItEmail } from './LinkItEmail';
109
export { LinkItTwitter } from './LinkItTwitter';
11-
export { LinkItJira } from './LinkItJira';
1210
export { LinkItHashtag } from './LinkItHashtag';
1311
export { LinkItMention } from './LinkItMention';

src/index.tsx

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,11 @@ export {
77
LinkItUrl,
88
LinkItEmail,
99
LinkItTwitter,
10-
LinkItJira,
1110
LinkItHashtag,
1211
LinkItMention,
1312
UrlComponent,
1413
EmailComponent,
1514
TwitterComponent,
16-
JiraComponent,
1715
HashTagComponent,
1816
MentionComponent,
1917
} from './components';
@@ -23,7 +21,6 @@ export {
2321
urlRegex,
2422
emailRegex,
2523
twitterRegex,
26-
jiraRegex,
2724
hashtagRegex,
2825
mentionRegex,
2926
} from './utils/regexPatterns';
@@ -34,8 +31,6 @@ export type {
3431
ReactLinkProps,
3532
ReactLinkItProps,
3633
ReactHOCLinkProps,
37-
ReactJiraLinkProps,
38-
ReactJiraHOCLinkProps,
3934
ReactHashTagLinkProps,
4035
ReactHashTagHOCLinkProps,
4136
ReactMentionLinkProps,

0 commit comments

Comments
 (0)