��# d o m - t e x t - h i g h l i g h t e r
T h e ` d o m - t e x t - h i g h l i g h t e r ` l i b r a r y p r o v i d e s a n e a s y a n d c u s t o m i z a b l e w a y t o h i g h l i g h t t e x t w i t h i n a w e b p a g e . T h i s l i b r a r y s u p p o r t s c u s t o m h i g h l i g h t s t y l e s , a n n o t a t i o n , p e r s i s t e n c e , a n d m o r e , m a k i n g i t a v e r s a t i l e t o o l f o r t e x t h i g h l i g h t i n g n e e d s .
# # F e a t u r e s
- * * C u s t o m H i g h l i g h t S t y l e s * * : D e f i n e m u l t i p l e s t y l e s f o r d i f f e r e n t t y p e s o f h i g h l i g h t s .
- * * H i g h l i g h t R e m o v a l * * : R e m o v e h i g h l i g h t s f r o m s e l e c t e d t e x t .
- * * P e r s i s t e n c e * * : S a v e a n d r e s t o r e h i g h l i g h t s , e n a b l i n g h i g h l i g h t s t o p e r s i s t a c r o s s p a g e r e l o a d s o r s e s s i o n s .
- * * C a l l b a c k s * * : A d d c a l l b a c k s f o r w h e n t e x t i s h i g h l i g h t e d o r u n h i g h l i g h t e d .
- * * T e x t A n n o t a t i o n * * : A d d a n n o t a t i o n s o r c o m m e n t s t o h i g h l i g h t e d t e x t .
- * * H i g h l i g h t N a v i g a t i o n * * : N a v i g a t e b e t w e e n h i g h l i g h t s .
- * * A c c e s s i b i l i t y * * : E n s u r e h i g h l i g h t s a r e a c c e s s i b l e ( e . g . , A R I A r o l e s , s c r e e n r e a d e r s u p p o r t ) .
- * * H i g h l i g h t M a n a g e m e n t * * : G e t a l l h i g h l i g h t s , c l e a r a l l h i g h l i g h t s , a n d e x p o r t h i g h l i g h t s .
# # I n s t a l l a t i o n
T o i n s t a l l t h e ` d o m - t e x t - h i g h l i g h t e r ` l i b r a r y , u s e n p m :
` ` ` s h
n p m i n s t a l l d o m - t e x t - h i g h l i g h t e r
` ` `
T h e n i m p o r t i t i n t o y o u r p r o j e c t :
` ` ` t y p e s c r i p t
i m p o r t H i g h l i g h t e r f r o m " d o m - t e x t - h i g h l i g h t e r " ;
` ` `
# # U s a g e
# # # I n i t i a l i z a t i o n
Y o u c a n i n i t i a l i z e t h e H i g h l i g h t e r l i b r a r y w i t h c u s t o m o p t i o n s f o r h i g h l i g h t s t y l i n g . I f n o o p t i o n s a r e p r o v i d e d , d e f a u l t s t y l e s w i l l b e a p p l i e d .
` ` ` t y p e s c r i p t
c o n s t c u s t o m O p t i o n s = {
b a c k g r o u n d C o l o r : " l i g h t b l u e " ,
t e x t C o l o r : " b l a c k " ,
f o n t W e i g h t : " b o l d " ,
c u s t o m C l a s s : " c u s t o m - h i g h l i g h t " ,
} ;
c o n s t h i g h l i g h t e r = H i g h l i g h t e r . g e t I n s t a n c e ( c u s t o m O p t i o n s ) ;
` ` `
# # # A d d i n g H i g h l i g h t L i s t e n e r
T o e n a b l e h i g h l i g h t i n g f u n c t i o n a l i t y , y o u n e e d t o a d d a h i g h l i g h t l i s t e n e r t o t h e d e s i r e d e l e m e n t .
` ` ` t y p e s c r i p t
h i g h l i g h t e r . a d d H i g h l i g h t L i s t e n e r ( " c o n t e n t " ) ;
` ` `
# # # R e m o v i n g H i g h l i g h t L i s t e n e r
T o r e m o v e t h e h i g h l i g h t l i s t e n e r f r o m a n e l e m e n t :
` ` ` t y p e s c r i p t
h i g h l i g h t e r . r e m o v e H i g h l i g h t L i s t e n e r ( " c o n t e n t " ) ;
` ` `
# # # H i g h l i g h t i n g T e x t
T e x t h i g h l i g h t i n g i s a u t o m a t i c a l l y h a n d l e d w h e n t h e u s e r s e l e c t s t e x t w i t h i n t h e e l e m e n t t h a t h a s t h e h i g h l i g h t l i s t e n e r .
# # # R e m o v i n g H i g h l i g h t s
T o r e m o v e a l l h i g h l i g h t s :
` ` ` t y p e s c r i p t
h i g h l i g h t e r . r e m o v e H i g h l i g h t s ( ) ;
` ` `
# # # A d d i n g A n n o t a t i o n s
T o a d d a n a n n o t a t i o n t o a s p e c i f i c h i g h l i g h t :
` ` ` t y p e s c r i p t
c o n s t h i g h l i g h t I d = " h i g h l i g h t - i d " ; / / R e p l a c e w i t h t h e a c t u a l h i g h l i g h t I D
c o n s t a n n o t a t i o n = " T h i s i s a n a n n o t a t i o n " ;
h i g h l i g h t e r . a d d A n n o t a t i o n T o H i g h l i g h t ( h i g h l i g h t I d , a n n o t a t i o n ) ;
` ` `
# # # M a n a g i n g H i g h l i g h t s
# # # # G e t A l l H i g h l i g h t s
T o r e t r i e v e a l l h i g h l i g h t s :
` ` ` t y p e s c r i p t
c o n s t h i g h l i g h t s = h i g h l i g h t e r . g e t H i g h l i g h t s ( ) ;
c o n s o l e . l o g ( h i g h l i g h t s ) ;
` ` `
# # # # S a v e H i g h l i g h t s
T o s a v e h i g h l i g h t s t o l o c a l s t o r a g e :
` ` ` t y p e s c r i p t
h i g h l i g h t e r . s a v e H i g h l i g h t s ( ) ;
` ` `
# # # # L o a d H i g h l i g h t s
T o l o a d h i g h l i g h t s f r o m l o c a l s t o r a g e :
` ` ` t y p e s c r i p t
h i g h l i g h t e r . l o a d H i g h l i g h t s ( ) ;
` ` `
# # O p t i o n s
T h e ` H i g h l i g h t O p t i o n s ` i n t e r f a c e a l l o w s y o u t o c u s t o m i z e t h e a p p e a r a n c e o f t h e h i g h l i g h t s . T h e o p t i o n s i n c l u d e :
- ` b a c k g r o u n d C o l o r ` : T h e b a c k g r o u n d c o l o r o f t h e h i g h l i g h t ( d e f a u l t : " y e l l o w " ) .
- ` t e x t C o l o r ` : T h e t e x t c o l o r o f t h e h i g h l i g h t ( d e f a u l t : " i n h e r i t " ) .
- ` f o n t W e i g h t ` : T h e f o n t w e i g h t o f t h e h i g h l i g h t e d t e x t ( d e f a u l t : " i n h e r i t " ) .
- ` f o n t S t y l e ` : T h e f o n t s t y l e o f t h e h i g h l i g h t e d t e x t ( d e f a u l t : " i n h e r i t " ) .
- ` c u s t o m C l a s s ` : C u s t o m C S S c l a s s f o r a d d i t i o n a l s t y l i n g ( d e f a u l t : " " ) .
# # E x a m p l e
H e r e ' s a c o m p l e t e e x a m p l e d e m o n s t r a t i n g h o w t o u s e t h e H i g h l i g h t e r l i b r a r y :
` ` ` t y p e s c r i p t
i m p o r t H i g h l i g h t e r f r o m " d o m - t e x t - h i g h l i g h t e r " ;
/ / E x a m p l e u s a g e w i t h c u s t o m o p t i o n s
c o n s t c u s t o m O p t i o n s = {
b a c k g r o u n d C o l o r : " l i g h t b l u e " ,
t e x t C o l o r : " b l a c k " ,
f o n t W e i g h t : " b o l d " ,
c u s t o m C l a s s : " c u s t o m - h i g h l i g h t " ,
} ;
c o n s t h i g h l i g h t e r = H i g h l i g h t e r . g e t I n s t a n c e ( c u s t o m O p t i o n s ) ;
/ / A d d l i s t e n e r t o h i g h l i g h t t e x t i n a n e l e m e n t w i t h i d " c o n t e n t "
h i g h l i g h t e r . a d d H i g h l i g h t L i s t e n e r ( " c o n t e n t " ) ;
/ / S a v e h i g h l i g h t s t o l o c a l s t o r a g e
h i g h l i g h t e r . s a v e H i g h l i g h t s ( ) ;
/ / L o a d h i g h l i g h t s f r o m l o c a l s t o r a g e
h i g h l i g h t e r . l o a d H i g h l i g h t s ( ) ;
/ / R e m o v e a l l h i g h l i g h t s
h i g h l i g h t e r . r e m o v e H i g h l i g h t s ( ) ;
/ / A d d a n n o t a t i o n t o a s p e c i f i c h i g h l i g h t
c o n s t h i g h l i g h t I d = " h i g h l i g h t - i d " ; / / R e p l a c e w i t h t h e a c t u a l h i g h l i g h t I D
c o n s t a n n o t a t i o n = " T h i s i s a n a n n o t a t i o n " ;
h i g h l i g h t e r . a d d A n n o t a t i o n T o H i g h l i g h t ( h i g h l i g h t I d , a n n o t a t i o n ) ;
` ` `
# # L i c e n s e
T h i s p r o j e c t i s l i c e n s e d u n d e r t h e M I T L i c e n s e - s e e t h e [ L I C E N S E ] ( L I C E N S E ) f i l e f o r d e t a i l s .
# # C o n t r i b u t i n g
C o n t r i b u t i o n s a r e w e l c o m e ! P l e a s e o p e n a n i s s u e o r s u b m i t a p u l l r e q u e s t f o r a n y b u g f i x e s o r e n h a n c e m e n t s .
# # A c k n o w l e d g e m e n t s
S p e c i a l t h a n k s t o a l l t h e c o n t r i b u t o r s a n d t h e o p e n - s o u r c e c o m m u n i t y f o r t h e i r c o n t i n u o u s s u p p o r t a n d c o n t r i b u t i o n s .
# # C o n t a c t
I f y o u h a v e a n y q u e s t i o n s o r f e e d b a c k , f e e l f r e e t o r e a c h o u t t o t h e m a i n t a i n e r s a t [ y o u r - e m a i l @ e x a m p l e . c o m ] .
dom-text-highlighter
0.0.2 • Public • Published Readme
Keywords
nonePackage Sidebar
Install
npm i dom-text-highlighter
Weekly Downloads
3
Version
0.0.2
License
none
Unpacked Size
15.5 kB
Total Files
5